org.netbeans.modules.java.api.common.queries

Class QuerySupport

java.lang.Object

org.netbeans.modules.java.api.common.queries.QuerySupport

public final class QuerySupport
extends Object

Support class for creating different types of queries implementations.

Method Summary

Modifier and Type	Method and Description
static AnnotationProcessingQueryImplementation	createAnnotationProcessingQuery(AntProjectHelper helper, PropertyEvaluator evaluator, String annotationProcessingEnabledProperty, String annotationProcessingEnabledInEditorProperty, String runAllAnnotationProcessorsProperty, String annotationProcessorsProperty, String sourceOutputProperty, String processorOptionsProperty) Create a new query to provide annotation processing configuration data.
static CompilerOptionsQueryImplementation	createAutomaticModuleNameQuery(AntProjectHelper helper, PropertyEvaluator eval, SourceRoots srcRoots, String manifestProperty) Creates an Automatic-Module-Name query.
static BinaryForSourceQueryImplementation	createBinaryForSourceQueryImplementation(SourceRoots src, SourceRoots test, AntProjectHelper helper, PropertyEvaluator eval) Shortcut version of QuerySupport.createBinaryForSourceQueryImplementation(org.netbeans.modules.java.api.common.SourceRoots, org.netbeans.modules.java.api.common.SourceRoots, org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, java.lang.String[], java.lang.String[]) which assumes that build classes folder is stored in property build.classes.dir and built test classes folder is stored in property build.test.classes.dir.
static BinaryForSourceQueryImplementation	createBinaryForSourceQueryImplementation(SourceRoots src, SourceRoots test, AntProjectHelper helper, PropertyEvaluator eval, String[] sourceProps, String[] testProps) Creates an implementation of BinaryForSourceQueryImplementation which maps given project source roots and test roots to given folders with built classes and built test classes.
static SourceForBinaryQueryImplementation	createCompiledSourceForBinaryQuery(AntProjectHelper helper, PropertyEvaluator evaluator, SourceRoots srcRoots, SourceRoots testRoots) Create a new query to provide information about where Java sources corresponding to binaries (classfiles) can be found.
static SourceForBinaryQueryImplementation	createCompiledSourceForBinaryQuery(AntProjectHelper helper, PropertyEvaluator evaluator, SourceRoots srcRoots, SourceRoots testRoots, String[] binaryProperties, String[] testBinaryProperties) Create a new query to provide information about where Java sources corresponding to binaries (classfiles) can be found.
static CompilerOptionsQueryImplementation	createCompilerOptionsQuery(PropertyEvaluator evaluator, String additionalCompilerOptionsProperty) Create a new query to find out explicit compiler options for Java source files.
static FileBuiltQueryImplementation	createFileBuiltQuery(AntProjectHelper helper, PropertyEvaluator evaluator, SourceRoots sourceRoots, SourceRoots testRoots) Create a new query to test whether a file can be considered to be built (up to date).
static FileEncodingQueryImplementation	createFileEncodingQuery(PropertyEvaluator eval, String sourceEncodingPropertyName) Create a new query to provide information about encoding of a file.
static JavadocForBinaryQueryImplementation	createJavadocForBinaryQuery(AntProjectHelper helper, PropertyEvaluator evaluator) Create a new query to find Javadoc.
static JavadocForBinaryQueryImplementation	createJavadocForBinaryQuery(AntProjectHelper helper, PropertyEvaluator evaluator, String[] binaryProperties) Create a new query to find Javadoc.
static AccessibilityQueryImplementation2	createModuleInfoAccessibilityQuery(SourceRoots sources, SourceRoots tests) Creates a AccessibilityQueryImplementation2 based on the module-info.
static AccessibilityQueryImplementation2	createModuleInfoAccessibilityQuery(SourceRoots sourceModules, SourceRoots sources, SourceRoots testModules, SourceRoots tests) Creates a AccessibilityQueryImplementation2 based on the module-info for multi module projects.
static AntArtifactProvider	createMultiModuleAntArtifactProvider(AntProjectHelper helper, PropertyEvaluator eval, SourceRoots sourceModules, SourceRoots sources) Creates a AntArtifactProvider for multi-module project.
static BinaryForSourceQueryImplementation	createMultiModuleBinaryForSourceQuery(AntProjectHelper helper, PropertyEvaluator eval, SourceRoots sourceModules, SourceRoots srcRoots, SourceRoots testModules, SourceRoots testRoots) Creates a BinaryForSourceQueryImplementation for multi-module project.
static FileBuiltQueryImplementation	createMultiModuleFileBuiltQuery(AntProjectHelper helper, PropertyEvaluator evaluator, SourceRoots sourceModules, SourceRoots sourceRoots, SourceRoots testModules, SourceRoots testRoots) Creates a FileBuiltQueryImplementation for a multi-module project.
static MultiModuleGroupQuery	createMultiModuleGroupQuery(AntProjectHelper helper, PropertyEvaluator evaluator, Sources src, Roots... roots) Returns MultiModuleGroupQuery implementation suitable for modular Java projects.
static JavadocForBinaryQueryImplementation	createMultiModuleJavadocForBinaryQuery(AntProjectHelper helper, PropertyEvaluator eval, SourceRoots sourceModules, SourceRoots srcRoots) Creates a JavadocForBinaryQueryImplementation for multi-module project.
static SourceForBinaryQueryImplementation	createMultiModuleSourceForBinaryQuery(AntProjectHelper helper, PropertyEvaluator eval, SourceRoots sourceModules, SourceRoots srcRoots, SourceRoots testModules, SourceRoots testRoots) Creates a SourceForBinaryQueryImplementation for multi-module project.
static MultipleRootsUnitTestForSourceQueryImplementation	createMultiModuleUnitTestForSourceQuery(SourceRoots sourceModules, SourceRoots sourceRoots, SourceRoots testModules, SourceRoots testRoots) Creates a MultipleRootsUnitTestForSourceQueryImplementation for a multi-module project.
static CompilerOptionsQueryImplementation	createMultiModuleUnitTestsCompilerOptionsQuery(Project project, SourceRoots sourceModules, SourceRoots sourceRoots, SourceRoots testModules, SourceRoots testRoots) Create a new query to set up explicit compiler options needed for unit test compilation in a multi module project.
static ProjectInformation	createProjectInformation(AntProjectHelper projectHelper, Project project, Icon icon)
static ProjectInformation	createProjectInformation(UpdateHelper updateHelper, Project project, Icon icon)
static SharabilityQueryImplementation	createSharabilityQuery(AntProjectHelper helper, PropertyEvaluator evaluator, SourceRoots srcRoots, SourceRoots testRoots) Deprecated. since 1.35 use QuerySupport.createSharabilityQuery2(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, org.netbeans.modules.java.api.common.SourceRoots, org.netbeans.modules.java.api.common.SourceRoots, java.lang.String...) instead
static SharabilityQueryImplementation	createSharabilityQuery(AntProjectHelper helper, PropertyEvaluator evaluator, SourceRoots srcRoots, SourceRoots testRoots, String... additionalSourceRoots) Deprecated. since 1.35 use QuerySupport.createSharabilityQuery2(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, org.netbeans.modules.java.api.common.SourceRoots, org.netbeans.modules.java.api.common.SourceRoots, java.lang.String...) instead
static SharabilityQueryImplementation2	createSharabilityQuery2(AntProjectHelper helper, PropertyEvaluator evaluator, SourceRoots srcRoots, SourceRoots testRoots, String... additionalSourceRoots) Create a new query to provide information about files sharability.
static SourceLevelQueryImplementation	createSourceLevelQuery(PropertyEvaluator evaluator) Deprecated. Use QuerySupport.createSourceLevelQuery(org.netbeans.spi.project.support.ant.PropertyEvaluator)
static SourceLevelQueryImplementation2	createSourceLevelQuery2(PropertyEvaluator evaluator) Create a new query to find out source level of Java source files (SourceLevelQueryImplementation2).
static SourceLevelQueryImplementation2	createSourceLevelQuery2(PropertyEvaluator evaluator, String platformType) Create a new query to find out source level of Java source files (SourceLevelQueryImplementation2).
static Sources	createSources(Project project, AntProjectHelper helper, PropertyEvaluator evaluator, Roots... roots) Returns Sources implementation designed for projects that supports adding or removing of the source roots.
static CreateFromTemplateAttributesProvider	createTemplateAttributesProvider(AntProjectHelper helper, FileEncodingQueryImplementation encodingQuery) Creates an implementation of CreateFromTemplateAttributesProvider providing attributes for the project license and encoding.
static MultipleRootsUnitTestForSourceQueryImplementation	createUnitTestForSourceQuery(SourceRoots sourceRoots, SourceRoots testRoots) Create a new query to find Java package roots of unit tests for Java package root of sources and vice versa.
static CompilerOptionsQueryImplementation	createUnitTestsCompilerOptionsQuery(PropertyEvaluator eval, SourceRoots srcRoots, SourceRoots testRoots) Create a new query to set up explicit compiler options needed for unit test compilation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createCompiledSourceForBinaryQuery

public static SourceForBinaryQueryImplementation createCompiledSourceForBinaryQuery(AntProjectHelper helper,
                                                                                    PropertyEvaluator evaluator,
                                                                                    SourceRoots srcRoots,
                                                                                    SourceRoots testRoots)

Create a new query to provide information about where Java sources corresponding to binaries (classfiles) can be found.

Parameters:

helper - AntProjectHelper used for resolving files, e.g. output directory.

evaluator - PropertyEvaluator used for obtaining project properties.

srcRoots - a list of source roots.

testRoots - a list of test roots.

Returns:

SourceForBinaryQueryImplementation to provide information about where Java sources can be found.

See Also:

SourceForBinaryQueryImplementation

createMultiModuleSourceForBinaryQuery

@NonNull
public static SourceForBinaryQueryImplementation createMultiModuleSourceForBinaryQuery(@NonNull
                                                                                                AntProjectHelper helper,
                                                                                                @NonNull
                                                                                                PropertyEvaluator eval,
                                                                                                @NonNull
                                                                                                SourceRoots sourceModules,
                                                                                                @NonNull
                                                                                                SourceRoots srcRoots,
                                                                                                @NonNull
                                                                                                SourceRoots testModules,
                                                                                                @NonNull
                                                                                                SourceRoots testRoots)

Creates a SourceForBinaryQueryImplementation for multi-module project.

Parameters:

helper - AntProjectHelper used for resolving files, e.g. output directory

eval - PropertyEvaluator used for obtaining project properties

sourceModules - the module roots

srcRoots - the source roots

testModules - the test module roots

testRoots - the test source roots

Returns:

the SourceForBinaryQueryImplementation

Since:

1.93

createCompiledSourceForBinaryQuery

public static SourceForBinaryQueryImplementation createCompiledSourceForBinaryQuery(@NonNull
                                                                                    AntProjectHelper helper,
                                                                                    @NonNull
                                                                                    PropertyEvaluator evaluator,
                                                                                    @NonNull
                                                                                    SourceRoots srcRoots,
                                                                                    @NullAllowed
                                                                                    SourceRoots testRoots,
                                                                                    @NonNull
                                                                                    String[] binaryProperties,
                                                                                    @NullAllowed
                                                                                    String[] testBinaryProperties)

Create a new query to provide information about where Java sources corresponding to binaries (classfiles) can be found.

Parameters:

helper - AntProjectHelper used for resolving files, e.g. output directory.

evaluator - PropertyEvaluator used for obtaining project properties.

srcRoots - a list of source roots.

testRoots - a list of test roots, may be null if the project does not support tests.

binaryProperties - array of property names of binary artifacts produced by this project, e.g. dist.jar

testBinaryProperties - array of property names of test binary artifacts produced by this project, e.g. build.test.classes.dir If the testRoots parameter is null this parameter has to be null as well.

Returns:

SourceForBinaryQueryImplementation to provide information about where Java sources can be found.

Since:

org.netbeans.modules.java.api.common/0 1.3

See Also:

SourceForBinaryQueryImplementation

createFileEncodingQuery

public static FileEncodingQueryImplementation createFileEncodingQuery(PropertyEvaluator eval,
                                                                      String sourceEncodingPropertyName)

Create a new query to provide information about encoding of a file. The returned query listens to the changes in particular property values.

Parameters:

eval - PropertyEvaluator used for obtaining the value of source encoding.

sourceEncodingPropertyName - the source encoding property name.

Returns:

a FileEncodingQueryImplementation to provide information about encoding of a file.

createJavadocForBinaryQuery

public static JavadocForBinaryQueryImplementation createJavadocForBinaryQuery(AntProjectHelper helper,
                                                                              PropertyEvaluator evaluator)

Create a new query to find Javadoc. The returned query listens on changes of the Javadoc directory.

Parameters:

helper - AntProjectHelper used for resolving files, e.g. output directory.

evaluator - PropertyEvaluator used for obtaining the Javadoc root.

Returns:

a JavadocForBinaryQueryImplementation to find Javadoc.

createMultiModuleJavadocForBinaryQuery

@NonNull
public static JavadocForBinaryQueryImplementation createMultiModuleJavadocForBinaryQuery(@NonNull
                                                                                                  AntProjectHelper helper,
                                                                                                  @NonNull
                                                                                                  PropertyEvaluator eval,
                                                                                                  @NonNull
                                                                                                  SourceRoots sourceModules,
                                                                                                  @NonNull
                                                                                                  SourceRoots srcRoots)

Creates a JavadocForBinaryQueryImplementation for multi-module project.

Parameters:

helper - AntProjectHelper used for resolving files, e.g. output directory

eval - PropertyEvaluator used for obtaining project properties

sourceModules - the module roots

srcRoots - the source roots

Returns:

the JavadocForBinaryQueryImplementation

Since:

1.94

createJavadocForBinaryQuery

public static JavadocForBinaryQueryImplementation createJavadocForBinaryQuery(AntProjectHelper helper,
                                                                              PropertyEvaluator evaluator,
                                                                              String[] binaryProperties)

Create a new query to find Javadoc. The returned query listens on changes of the Javadoc directory.

Parameters:

helper - AntProjectHelper used for resolving files, e.g. output directory.

evaluator - PropertyEvaluator used for obtaining the Javadoc root.

binaryProperties - array of property names of binary artifacts produced by this project, e.g. dist.jar

Returns:

a JavadocForBinaryQueryImplementation to find Javadoc.

Since:

org.netbeans.modules.java.api.common/0 1.3

createSharabilityQuery2

public static SharabilityQueryImplementation2 createSharabilityQuery2(@NonNull
                                                                      AntProjectHelper helper,
                                                                      @NonNull
                                                                      PropertyEvaluator evaluator,
                                                                      @NonNull
                                                                      SourceRoots srcRoots,
                                                                      @NullAllowed
                                                                      SourceRoots testRoots,
                                                                      @NullAllowed
                                                                      String... additionalSourceRoots)

Create a new query to provide information about files sharability. The returned query listens to the changes in particular source roots.

Parameters:

helper - AntProjectHelper used for creating a query itself.

evaluator - a property evaluator to interpret paths with.

srcRoots - a list of source roots to treat as sharable.

testRoots - a list of test roots to treat as sharable, may be null if the project does not support tests

additionalSourceRoots - additional paths to treat as sharable (just pure property names, do not use ${ and } characters). Can be null.

Returns:

a query to provide information about files sharability.

Since:

1.35

createSharabilityQuery

@Deprecated
public static SharabilityQueryImplementation createSharabilityQuery(@NonNull
                                                                                AntProjectHelper helper,
                                                                                @NonNull
                                                                                PropertyEvaluator evaluator,
                                                                                @NonNull
                                                                                SourceRoots srcRoots,
                                                                                @NullAllowed
                                                                                SourceRoots testRoots,
                                                                                @NullAllowed
                                                                                String... additionalSourceRoots)

Deprecated. since 1.35 use QuerySupport.createSharabilityQuery2(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, org.netbeans.modules.java.api.common.SourceRoots, org.netbeans.modules.java.api.common.SourceRoots, java.lang.String...) instead

createSharabilityQuery

@Deprecated
public static SharabilityQueryImplementation createSharabilityQuery(AntProjectHelper helper,
                                                                                PropertyEvaluator evaluator,
                                                                                SourceRoots srcRoots,
                                                                                SourceRoots testRoots)

Deprecated. since 1.35 use QuerySupport.createSharabilityQuery2(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, org.netbeans.modules.java.api.common.SourceRoots, org.netbeans.modules.java.api.common.SourceRoots, java.lang.String...) instead

createSourceLevelQuery

@Deprecated
public static SourceLevelQueryImplementation createSourceLevelQuery(PropertyEvaluator evaluator)

Deprecated. Use QuerySupport.createSourceLevelQuery(org.netbeans.spi.project.support.ant.PropertyEvaluator)

Create a new query to find out specification source level of Java source files.

Parameters:

evaluator - PropertyEvaluator used for obtaining needed properties.

Returns:

a SourceLevelQueryImplementation to find out specification source level of Java source files.

createSourceLevelQuery2

public static SourceLevelQueryImplementation2 createSourceLevelQuery2(@NonNull
                                                                      PropertyEvaluator evaluator)

Create a new query to find out source level of Java source files (SourceLevelQueryImplementation2).

Parameters:

evaluator - PropertyEvaluator used for obtaining needed properties.

Returns:

a SourceLevelQueryImplementation2 to find out source level of Java source files.

Since:

1.22

createSourceLevelQuery2

public static SourceLevelQueryImplementation2 createSourceLevelQuery2(@NonNull
                                                                      PropertyEvaluator evaluator,
                                                                      @NonNull
                                                                      String platformType)

Create a new query to find out source level of Java source files (SourceLevelQueryImplementation2).

Parameters:

evaluator - PropertyEvaluator used for obtaining needed properties.

platformType - the type of platform, for example "j2se"

Returns:

a SourceLevelQueryImplementation2 to find out source level of Java source files.

Since:

1.72

createCompilerOptionsQuery

@NonNull
public static CompilerOptionsQueryImplementation createCompilerOptionsQuery(@NonNull
                                                                                     PropertyEvaluator evaluator,
                                                                                     @NonNull
                                                                                     String additionalCompilerOptionsProperty)

Create a new query to find out explicit compiler options for Java source files.

Parameters:

evaluator - PropertyEvaluator used for obtaining needed properties

additionalCompilerOptionsProperty - the property holding the additional compiler options

Returns:

a CompilerOptionsQueryImplementation to find out explicit compiler options of Java source files.

Since:

1.81

createUnitTestsCompilerOptionsQuery

public static CompilerOptionsQueryImplementation createUnitTestsCompilerOptionsQuery(@NonNull
                                                                                     PropertyEvaluator eval,
                                                                                     @NonNull
                                                                                     SourceRoots srcRoots,
                                                                                     @NonNull
                                                                                     SourceRoots testRoots)

Create a new query to set up explicit compiler options needed for unit test compilation.

Parameters:

eval - the PropertyEvaluator

srcRoots - the source roots

testRoots - the test roots

Returns:

a CompilerOptionsQueryImplementation to find out unit test compiler options

Since:

1.82

createAutomaticModuleNameQuery

@NonNull
public static CompilerOptionsQueryImplementation createAutomaticModuleNameQuery(@NonNull
                                                                                         AntProjectHelper helper,
                                                                                         @NonNull
                                                                                         PropertyEvaluator eval,
                                                                                         @NonNull
                                                                                         SourceRoots srcRoots,
                                                                                         @NonNull
                                                                                         String manifestProperty)

Creates an Automatic-Module-Name query.

Parameters:

helper - the AntProjectHelper

eval - the PropertyEvaluator

srcRoots - the source roots

manifestProperty - the property holding the path to the manifest file

Returns:

a CompilerOptionsQueryImplementation to find out the Automatic-Module-Name

Since:

1.122

createMultiModuleUnitTestsCompilerOptionsQuery

@NonNull
public static CompilerOptionsQueryImplementation createMultiModuleUnitTestsCompilerOptionsQuery(@NonNull
                                                                                                         Project project,
                                                                                                         @NonNull
                                                                                                         SourceRoots sourceModules,
                                                                                                         @NonNull
                                                                                                         SourceRoots sourceRoots,
                                                                                                         @NonNull
                                                                                                         SourceRoots testModules,
                                                                                                         @NonNull
                                                                                                         SourceRoots testRoots)

Create a new query to set up explicit compiler options needed for unit test compilation in a multi module project.

Parameters:

project - the project to create a query for

sourceModules - the module roots

sourceRoots - the source roots

testModules - the test module roots

testRoots - the test source roots

Returns:

a CompilerOptionsQueryImplementation to find out unit test compiler options

Since:

1.107

createUnitTestForSourceQuery

public static MultipleRootsUnitTestForSourceQueryImplementation createUnitTestForSourceQuery(SourceRoots sourceRoots,
                                                                                             SourceRoots testRoots)

Create a new query to find Java package roots of unit tests for Java package root of sources and vice versa.

Parameters:

sourceRoots - a list of source roots.

testRoots - a list of test roots.

Returns:

a MultipleRootsUnitTestForSourceQueryImplementation to find Java package roots of unit tests for Java package root of sources and vice versa.

createMultiModuleUnitTestForSourceQuery

@NonNull
public static MultipleRootsUnitTestForSourceQueryImplementation createMultiModuleUnitTestForSourceQuery(@NonNull
                                                                                                                 SourceRoots sourceModules,
                                                                                                                 @NonNull
                                                                                                                 SourceRoots sourceRoots,
                                                                                                                 @NonNull
                                                                                                                 SourceRoots testModules,
                                                                                                                 @NonNull
                                                                                                                 SourceRoots testRoots)

Creates a MultipleRootsUnitTestForSourceQueryImplementation for a multi-module project.

Parameters:

sourceModules - the module roots

sourceRoots - the source roots

testModules - the test module roots

testRoots - the test source roots

Returns:

the newly created MultipleRootsUnitTestForSourceQueryImplementation

Since:

1.104

createFileBuiltQuery

public static FileBuiltQueryImplementation createFileBuiltQuery(AntProjectHelper helper,
                                                                PropertyEvaluator evaluator,
                                                                SourceRoots sourceRoots,
                                                                SourceRoots testRoots)

Create a new query to test whether a file can be considered to be built (up to date). The returned query listens to the changes in particular source roots.

Parameters:

helper - AntProjectHelper used for creating a query itself.

evaluator - PropertyEvaluator used for obtaining needed properties.

sourceRoots - a list of source roots.

testRoots - a list of test roots.

Returns:

a FileBuiltQueryImplementation to test whether a file can be considered to be built (up to date).

createMultiModuleFileBuiltQuery

@NonNull
public static FileBuiltQueryImplementation createMultiModuleFileBuiltQuery(@NonNull
                                                                                    AntProjectHelper helper,
                                                                                    @NonNull
                                                                                    PropertyEvaluator evaluator,
                                                                                    @NonNull
                                                                                    SourceRoots sourceModules,
                                                                                    @NonNull
                                                                                    SourceRoots sourceRoots,
                                                                                    @NonNull
                                                                                    SourceRoots testModules,
                                                                                    @NonNull
                                                                                    SourceRoots testRoots)

Creates a FileBuiltQueryImplementation for a multi-module project.

Parameters:

helper - the AntProjectHelper

evaluator - the PropertyEvaluator

sourceModules - the module roots

sourceRoots - the source roots

testModules - the test module roots

testRoots - the test source roots

Returns:

the FileBuiltQueryImplementation instance

Since:

1.103

createTemplateAttributesProvider

public static CreateFromTemplateAttributesProvider createTemplateAttributesProvider(AntProjectHelper helper,
                                                                                    FileEncodingQueryImplementation encodingQuery)

Creates an implementation of CreateFromTemplateAttributesProvider providing attributes for the project license and encoding.

Parameters:

helper - AntProjectHelper used for reading the project properties.

encodingQuery - FileEncodingQueryImplementation used to obtain an encoding.

Returns:

a CreateFromTemplateAttributesProvider.

Since:

1.1

createBinaryForSourceQueryImplementation

public static BinaryForSourceQueryImplementation createBinaryForSourceQueryImplementation(SourceRoots src,
                                                                                          SourceRoots test,
                                                                                          AntProjectHelper helper,
                                                                                          PropertyEvaluator eval,
                                                                                          String[] sourceProps,
                                                                                          String[] testProps)

Creates an implementation of BinaryForSourceQueryImplementation which maps given project source roots and test roots to given folders with built classes and built test classes.

Parameters:

src - project source roots

test - project test roots

helper - AntProjectHelper

eval - PropertyEvaluator

sourceProps - name of properties pointing to binaries

testProps - name of properties pointing to test binaries

Returns:

BinaryForSourceQueryImplementation

Since:

1.79

createBinaryForSourceQueryImplementation

public static BinaryForSourceQueryImplementation createBinaryForSourceQueryImplementation(SourceRoots src,
                                                                                          SourceRoots test,
                                                                                          AntProjectHelper helper,
                                                                                          PropertyEvaluator eval)

Shortcut version of QuerySupport.createBinaryForSourceQueryImplementation(org.netbeans.modules.java.api.common.SourceRoots, org.netbeans.modules.java.api.common.SourceRoots, org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, java.lang.String[], java.lang.String[]) which assumes that build classes folder is stored in property build.classes.dir and built test classes folder is stored in property build.test.classes.dir.

Parameters:

src - project source roots

test - project test roots

helper - AntProjectHelper

eval - PropertyEvaluator

Returns:

BinaryForSourceQueryImplementation

Since:

org.netbeans.modules.java.api.common/1 1.5

createMultiModuleBinaryForSourceQuery

@NonNull
public static BinaryForSourceQueryImplementation createMultiModuleBinaryForSourceQuery(@NonNull
                                                                                                AntProjectHelper helper,
                                                                                                @NonNull
                                                                                                PropertyEvaluator eval,
                                                                                                @NonNull
                                                                                                SourceRoots sourceModules,
                                                                                                @NonNull
                                                                                                SourceRoots srcRoots,
                                                                                                @NonNull
                                                                                                SourceRoots testModules,
                                                                                                @NonNull
                                                                                                SourceRoots testRoots)

Creates a BinaryForSourceQueryImplementation for multi-module project.

Parameters:

helper - AntProjectHelper used for resolving files, e.g. output directory

eval - PropertyEvaluator used for obtaining project properties

sourceModules - the module roots

srcRoots - the source roots

testModules - the test module roots

testRoots - the test source roots

Returns:

the BinaryForSourceQueryImplementation

Since:

1.93

createAnnotationProcessingQuery

public static AnnotationProcessingQueryImplementation createAnnotationProcessingQuery(AntProjectHelper helper,
                                                                                      PropertyEvaluator evaluator,
                                                                                      String annotationProcessingEnabledProperty,
                                                                                      String annotationProcessingEnabledInEditorProperty,
                                                                                      String runAllAnnotationProcessorsProperty,
                                                                                      String annotationProcessorsProperty,
                                                                                      String sourceOutputProperty,
                                                                                      String processorOptionsProperty)

Create a new query to provide annotation processing configuration data.

Parameters:

helper - project's AntProjectHelper

evaluator - project's evaluator

annotationProcessingEnabledProperty - property whose value says whether the annotation processing is enabled for the given project at all (will be returned from AnnotationProcessingQuery.Result.annotationProcessingEnabled())

annotationProcessingEnabledInEditorProperty - property whose value says whether the annotation processing should be enabled in the editor (will be returned from AnnotationProcessingQuery.Result.annotationProcessingEnabled())

runAllAnnotationProcessorsProperty - when true, AnnotationProcessingQuery.Result.annotationProcessorsToRun() will return null

annotationProcessorsProperty - should contain comma separated list of annotation processors to run (will be returned from AnnotationProcessingQuery.Result.annotationProcessorsToRun())

sourceOutputProperty - directory to which the annotation processors generate source files (will be returned from AnnotationProcessingQuery.Result.sourceOutputDirectory())

processorOptionsProperty - options passed to the annotation processors (-Akey=value)

Returns:

a AnnotationProcessingQueryImplementation to provide annotation processing configuration data for this project.

Since:

org.netbeans.modules.java.api.common/0 1.14

createProjectInformation

public static ProjectInformation createProjectInformation(AntProjectHelper projectHelper,
                                                          Project project,
                                                          Icon icon)

createProjectInformation

public static ProjectInformation createProjectInformation(UpdateHelper updateHelper,
                                                          Project project,
                                                          Icon icon)

createSources

public static Sources createSources(@NonNull
                                    Project project,
                                    @NonNull
                                    AntProjectHelper helper,
                                    @NonNull
                                    PropertyEvaluator evaluator,
                                    @NonNull
                                    Roots... roots)

Returns Sources implementation designed for projects that supports adding or removing of the source roots. The returned instance also implements SourceGroupModifierImplementation

Parameters:

project - the Project for which the Sources should be created

helper - the AntProjectHelper of the project, used only to resolve files

evaluator - the PropertyEvaluator to evaluate the properties

roots - the array of Roots providing the roots of given type

Returns:

the Sources instance implementing also the SourceGroupModifierImplementation interface

Since:

1.21

createMultiModuleGroupQuery

public static MultiModuleGroupQuery createMultiModuleGroupQuery(AntProjectHelper helper,
                                                                PropertyEvaluator evaluator,
                                                                Sources src,
                                                                Roots... roots)

Returns MultiModuleGroupQuery implementation suitable for modular Java projects.

Parameters:

helper - the AntProjectHelper of the project, used only to resolve files

evaluator - the PropertyEvaluator to evaluate the properties

roots - the array of Roots providing the roots

src - Sources objects to track changes to project definition

Returns:

multi-module implementation of MultiModuleGroupQuery

Since:

1.97

createModuleInfoAccessibilityQuery

@NonNull
public static AccessibilityQueryImplementation2 createModuleInfoAccessibilityQuery(@NonNull
                                                                                            SourceRoots sources,
                                                                                            @NonNull
                                                                                            SourceRoots tests)

Creates a AccessibilityQueryImplementation2 based on the module-info.

Parameters:

sources - the project source roots

tests - the project test roots

Returns:

the AccessibilityQueryImplementation2 instance

Since:

1.85

createModuleInfoAccessibilityQuery

@NonNull
public static AccessibilityQueryImplementation2 createModuleInfoAccessibilityQuery(@NonNull
                                                                                            SourceRoots sourceModules,
                                                                                            @NonNull
                                                                                            SourceRoots sources,
                                                                                            @NonNull
                                                                                            SourceRoots testModules,
                                                                                            @NonNull
                                                                                            SourceRoots tests)

Creates a AccessibilityQueryImplementation2 based on the module-info for multi module projects.

Parameters:

sourceModules - the module roots

sources - the source roots

testModules - the test module roots

tests - the test roots

Returns:

the AccessibilityQueryImplementation2 instance

Since:

1.97

createMultiModuleAntArtifactProvider

@NonNull
public static AntArtifactProvider createMultiModuleAntArtifactProvider(@NonNull
                                                                                AntProjectHelper helper,
                                                                                @NonNull
                                                                                PropertyEvaluator eval,
                                                                                @NonNull
                                                                                SourceRoots sourceModules,
                                                                                @NonNull
                                                                                SourceRoots sources)

Creates a AntArtifactProvider for multi-module project.

Parameters:

helper - the AntProjectHelper

eval - the PropertyEvaluator

sourceModules - the module roots

sources - the source roots

Returns:

the AntArtifactProvider instance

Since:

1.98