Package org.sonar.api.a3s

Interface A3SContextCollector

@Beta
@ScannerSide
public interface A3SContextCollector

Reserved for SonarSource internal usage.

Since:

13.4

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	A3SContextCollector.Item

Method Summary

Modifier and Type	Method	Description
void	collect(java.lang.String kind, java.lang.String metadata, java.util.Collection<A3SContextCollector.Item> items)	Collect a context for the current analysis.
boolean	isEnabled()	Check if the A3S context collector is enabled.
A3SContextCollector.Item	newFileItem(java.lang.String id, java.nio.file.Path path)

Method Detail

isEnabled

boolean isEnabled()

Check if the A3S context collector is enabled.

collect

void collect(java.lang.String kind,
             java.lang.String metadata,
             java.util.Collection<A3SContextCollector.Item> items)

Collect a context for the current analysis. If called multiple times with the same kind, the behavior is unspecified.

Parameters:

kind - a unique identifier in case there are multiple contexts for the same project. Can be used to retrieve this specific context later.

metadata - opaque metadata (for example in JSON format) describing the project

items - attachments to the context, for more efficient storage. Currently only file items are supported.

newFileItem

A3SContextCollector.Item newFileItem(java.lang.String id,
                                     java.nio.file.Path path)