GradleJavaSourceSet (Gradle Java Projects)

java.lang.Object
- org.netbeans.modules.gradle.java.api.GradleJavaSourceSet

All Implemented Interfaces:: Serializable

public final class GradleJavaSourceSet
extends Object
implements Serializable

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GradleJavaSourceSet.ClassPathType

static class GradleJavaSourceSet.SourceType

Nested Classes
Modifier and Type	Class and Description
`static class`	`GradleJavaSourceSet.ClassPathType`
`static class`	`GradleJavaSourceSet.SourceType`

Field Summary

Fields
Modifier and Type Field and Description

static String MAIN_SOURCESET_NAME

static String TEST_SOURCESET_NAME

static File UNKNOWN
Represents an unknown value.

Fields
Modifier and Type	Field and Description
`static String`	`MAIN_SOURCESET_NAME`
`static String`	`TEST_SOURCESET_NAME`
`static File`	`UNKNOWN` Represents an unknown value.

Constructor Summary

Constructors
Constructor and Description

GradleJavaSourceSet(String name)

Constructors
Constructor and Description
`GradleJavaSourceSet(String name)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`contains(File f)` Returns `true` if the given file belongs either to the sources or the outputs of this SourceSet.
`boolean`	`equals(Object obj)`
`File`	`findResource(String name)` Tries to find a resource given by its relative path name in the directories associated with this SourceSet.
`File`	`findResource(String name, boolean includeOutputs, GradleJavaSourceSet.SourceType... types)` Tries to find a resource given by its relative path name in the directories associated with this SourceSet.
`Collection<File>`	`getAllDirs()`
`Collection<File>`	`getAllDirs(boolean deduplicate)` Returns all possible configured source directories regardless of their existence.
`String`	`getAnnotationProcessorConfigurationName()` The name of the annotation processor path configuration.
`Set<File>`	`getAnnotationProcessorPath()` The annotation processor path configured for this source set.
`Collection<File>`	`getAvailableDirs()`
`Collection<File>`	`getAvailableDirs(boolean deduplicate)` Returns all configured and existing source directories.
`String`	`getBuildTaskName(GradleJavaSourceSet.SourceType type)`
`String`	`getClassesTaskName()`
`Set<File>`	`getCompileClassPath()`
`String`	`getCompileConfigurationName()` Deprecated. No replacement.
`List<String>`	`getCompilerArgs(GradleJavaSourceSet.SourceType type)` Returns the compiler arguments for this source set defined for the given language.
`File`	`getCompilerJavaHome(GradleJavaSourceSet.SourceType type)` Returns the JDK Home directory of the JVM what would be used during the compilation.
`String`	`getCompileTaskName(String language)`
`Set<File>`	`getGeneratedSourcesDirs()` The directories where sources are generated, e.g.
`Set<File>`	`getGroovyDirs()`
`Set<File>`	`getJavaDirs()`
`Set<File>`	`getKotlinDirs()`
`String`	`getName()`
`File`	`getOutputClassDir(GradleJavaSourceSet.SourceType srcType)` Returns output directories for the given source type in the sourceset.
`Set<File>`	`getOutputClassDirs()`
`File`	`getOutputResources()` Return the directory of resources output.
`String`	`getProcessResourcesTaskName()`
`Set<File>`	`getResourcesDirs()`
`Set<File>`	`getRuntimeClassPath()`
`String`	`getRuntimeConfigurationName()` Deprecated. No replacement.
`Set<File>`	`getScalaDirs()`
`Set<GradleJavaSourceSet>`	`getSourceDependencies()` Returns those SourceSets within this project which output is on our compile/runtime classpath.
`Set<File>`	`getSourceDirs(GradleJavaSourceSet.SourceType type)`
`String`	`getSourcesCompatibility()` Deprecated. Use `GradleJavaSourceSet.getSourcesCompatibility(org.netbeans.modules.gradle.java.api.GradleJavaSourceSet.SourceType)` instead.
`String`	`getSourcesCompatibility(GradleJavaSourceSet.SourceType type)` This method returns the source compatibility defined for this source set for the given language type.
`GradleJavaSourceSet.SourceType`	`getSourceType(File f)` Returns the `GradleJavaSourceSet.SourceType` of the given file or `null` if that file cannot be associated with one.
`Set<GradleJavaSourceSet.SourceType>`	`getSourceTypes(File f)`
`String`	`getTargetCompatibility()` Deprecated. Use `GradleJavaSourceSet.getTargetCompatibility(org.netbeans.modules.gradle.java.api.GradleJavaSourceSet.SourceType)` instead.
`String`	`getTargetCompatibility(GradleJavaSourceSet.SourceType type)` This method returns the target compatibility defined for this source set for the given language type.
`String`	`getTaskName(String verb, String target)`
`int`	`hashCode()`
`boolean`	`hasOverlappingSourceDirs()`
`boolean`	`isTestSourceSet()`
`boolean`	`outputContains(File f)` Checks if a file most probably belongs to the output of this source set.
`String`	`relativePath(File f)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAIN_SOURCESET_NAME
```
public static final String MAIN_SOURCESET_NAME
```
    See Also:
    
    Constant Field Values
  - TEST_SOURCESET_NAME
```
public static final String TEST_SOURCESET_NAME
```
    See Also:
    
    Constant Field Values
  - UNKNOWN
```
public static final File UNKNOWN
```
    Represents an unknown value. This is different from a value that is not present, i.e. an output directory for a language that is not used in the project.
    
    Since:
    
    1.19
- Constructor Detail
  - GradleJavaSourceSet
```
public GradleJavaSourceSet(String name)
```
- Method Detail
  - getName
```
public String getName()
```
  - isTestSourceSet
```
public boolean isTestSourceSet()
```
  - getSourcesCompatibility
```
@Deprecated
public String getSourcesCompatibility()
```
    Deprecated. Use GradleJavaSourceSet.getSourcesCompatibility(org.netbeans.modules.gradle.java.api.GradleJavaSourceSet.SourceType) instead.
    
    This method returns the Java source compatibility defined for this source set.
    
    Returns:
  - getSourcesCompatibility
```
public String getSourcesCompatibility(GradleJavaSourceSet.SourceType type)
```
    This method returns the source compatibility defined for this source set for the given language type. The value is actually extracted from the compiler task defined for this source set and language type. If that cannot be determined for some reason this method returns "1.5".
    
    Parameters:
    
    type -
    
    Returns:
    
    the defined source compatibility or "1.5"
    
    Since:
    
    1.4
  - getTargetCompatibility
```
@Deprecated
public String getTargetCompatibility()
```
    Deprecated. Use GradleJavaSourceSet.getTargetCompatibility(org.netbeans.modules.gradle.java.api.GradleJavaSourceSet.SourceType) instead.
    
    This method returns the Java target compatibility defined for this source set.
    
    Returns:
  - getTargetCompatibility
```
public String getTargetCompatibility(GradleJavaSourceSet.SourceType type)
```
    This method returns the target compatibility defined for this source set for the given language type. The value is actually extracted from the compiler task defined for this source set and language type. If that cannot be determined for some reason this method returns the defined source compatibility.
    
    Parameters:
    
    type -
    
    Returns:
    
    the defined target compatibility
    
    Since:
    
    1.4
  - getRuntimeConfigurationName
```
@Deprecated
public String getRuntimeConfigurationName()
```
    Deprecated. No replacement.
    
    Returns the name of the configuration used by this SourceSet for compile. This method returns an null from Gradle 7.0 as the corresponding method has been removed in that version.
    
    Returns:
    
    the name of the configuration or null if that's not available.
  - getCompileConfigurationName
```
@Deprecated
public String getCompileConfigurationName()
```
    Deprecated. No replacement.
    
    Returns the name of the configuration used by this SourceSet for runtime. This method returns an null from Gradle 7.0 as the corresponding method has been removed in that version.
    
    Returns:
    
    the name of the configuration or null if that's not available.
  - getAnnotationProcessorConfigurationName
```
public String getAnnotationProcessorConfigurationName()
```
    The name of the annotation processor path configuration.
    
    Returns:
    
    Since:
    
    1.8
  - getSourceDirs
```
public Set<File> getSourceDirs(GradleJavaSourceSet.SourceType type)
```
  - getJavaDirs
```
public final Set<File> getJavaDirs()
```
  - getGroovyDirs
```
public final Set<File> getGroovyDirs()
```
  - getScalaDirs
```
public final Set<File> getScalaDirs()
```
  - getKotlinDirs
```
public final Set<File> getKotlinDirs()
```
    Since:
    
    1.15
  - getResourcesDirs
```
public final Set<File> getResourcesDirs()
```
  - getGeneratedSourcesDirs
```
public Set<File> getGeneratedSourcesDirs()
```
    The directories where sources are generated, e.g. by annotation processors. It only works for builds with Gradle 5.2 and above.
    
    Returns:
    
    Since:
    
    1.8
  - getAllDirs
```
public final Collection<File> getAllDirs(boolean deduplicate)
```
    Returns all possible configured source directories regardless of their existence.
    
    Parameters:
    
    deduplicate -
    
    Returns:
    
    all possible source directories.
  - getAllDirs
```
public final Collection<File> getAllDirs()
```
  - getAvailableDirs
```
public final Collection<File> getAvailableDirs(boolean deduplicate)
```
    Returns all configured and existing source directories.
    
    Returns:
    
    all existing source directories.
  - getAvailableDirs
```
public final Collection<File> getAvailableDirs()
```
  - getCompileClassPath
```
public Set<File> getCompileClassPath()
```
  - getRuntimeClassPath
```
public Set<File> getRuntimeClassPath()
```
  - getAnnotationProcessorPath
```
public Set<File> getAnnotationProcessorPath()
```
    The annotation processor path configured for this source set. If not defined it returns with the compile classpath.
    
    Returns:
    
    the annotation processor path for this sourceset.
    
    Since:
    
    1.8
  - getSourceType
```
public GradleJavaSourceSet.SourceType getSourceType(File f)
```
    Returns the GradleJavaSourceSet.SourceType of the given file or null if that file cannot be associated with one.
    
    Parameters:
    
    f - the file to check.
    
    Returns:
    
    the matching GradleJavaSourceSet.SourceType or null.
  - hasOverlappingSourceDirs
```
public boolean hasOverlappingSourceDirs()
```
  - getSourceTypes
```
public Set<GradleJavaSourceSet.SourceType> getSourceTypes(File f)
```
  - outputContains
```
public boolean outputContains(File f)
```
    Checks if a file most probably belongs to the output of this source set. It checks the output class dirs the output resource dir.
    
    Parameters:
    
    f - a file
    
    Returns:
    
    true if the file is in one of the output dirs of this source set.
  - getOutputClassDirs
```
public Set<File> getOutputClassDirs()
```
  - getOutputClassDir
```
public File getOutputClassDir(GradleJavaSourceSet.SourceType srcType)
```
    Returns output directories for the given source type in the sourceset. Returns null, if the source type has no output directories. Returns UNKNOWN, if the output location is not known.
    
    Parameters:
    
    srcType - language type
    
    Returns:
    
    location or null.
    
    Since:
    
    1.19
  - getOutputResources
```
public File getOutputResources()
```
    Return the directory of resources output.
    
    Returns:
    
    return the directory of output resources, it might be null.
  - getSourceDependencies
```
public Set<GradleJavaSourceSet> getSourceDependencies()
```
    Returns those SourceSets within this project which output is on our compile/runtime classpath. Most common example is: 'test' SourceSet usually returns the 'main' SourceSet as dependency.
    
    Returns:
    
    the in project SourceSet dependencies of this SourceSet.
  - contains
```
public boolean contains(File f)
```
    Returns true if the given file belongs either to the sources or the outputs of this SourceSet. Due to practical consideration if the project is a war project and this SourceSet is the main SourceSet then the content of the project 'webapp' folder is also associated with this SourceSet.
    
    Parameters:
    
    f - the file to test
    
    Returns:
    
    true if the given file can be associated with this SourceSet
  - findResource
```
public File findResource(String name)
```
    Tries to find a resource given by its relative path name in the directories associated with this SourceSet. The output directories are checked before the source ones. This method returns with the first resource if it is found.
    
    Parameters:
    
    name - the name of the resources, use "/" as separator character.
    
    Returns:
    
    the full path of the first resource found or null if no such resource can be associated with this SourceSet.
  - findResource
```
public File findResource(String name,
                         boolean includeOutputs,
                         GradleJavaSourceSet.SourceType... types)
```
    Tries to find a resource given by its relative path name in the directories associated with this SourceSet. The output directories are checked before the source ones (if they are included). This method returns with the first resource if it is found.
    
    Parameters:
    
    name - the name of the resources, use "/" as separator character.
    
    includeOutputs - include the outputs (classes and resources) in the search
    
    types - Source types to check, if omitted, all source types will be included.
    
    Returns:
    
    the full path of the first resource found or null if no such resource can be associated with this SourceSet.
  - relativePath
```
public String relativePath(File f)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getBuildTaskName
```
public String getBuildTaskName(GradleJavaSourceSet.SourceType type)
```
  - getCompilerJavaHome
```
public File getCompilerJavaHome(GradleJavaSourceSet.SourceType type)
```
    Returns the JDK Home directory of the JVM what would be used during the compilation. Currently the JAVA, GROOVY, and SCALA are expected to return a non null value. The home directory is determined by using the sourceSet default compile task. In Gradle it is possible to define additional compile tasks with different Java Toolchain. NetBeans would ignore those.
    
    Parameters:
    
    type - The source type of the compiler.
    
    Returns:
    
    The home directory of the JDK used for the default compile task.
    
    Since:
    
    1.26
  - getCompilerArgs
```
public List<String> getCompilerArgs(GradleJavaSourceSet.SourceType type)
```
    Returns the compiler arguments for this source set defined for the given language. The value is actually extracted from the compiler task defined for this source set and language type. If that cannot be determined for some reason this method returns an empty list.
    
    Parameters:
    
    type -
    
    Returns:
    
    Since:
    
    1.4
  - getCompileTaskName
```
public String getCompileTaskName(String language)
```
  - getProcessResourcesTaskName
```
public String getProcessResourcesTaskName()
```
  - getClassesTaskName
```
public String getClassesTaskName()
```
  - getTaskName
```
public String getTaskName(String verb,
                          String target)
```

Class GradleJavaSourceSet

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAIN_SOURCESET_NAME

TEST_SOURCESET_NAME

UNKNOWN

Constructor Detail

GradleJavaSourceSet

Method Detail

getName

isTestSourceSet

getSourcesCompatibility

getSourcesCompatibility

getTargetCompatibility

getTargetCompatibility

getRuntimeConfigurationName

getCompileConfigurationName

getAnnotationProcessorConfigurationName

getSourceDirs

getJavaDirs

getGroovyDirs

getScalaDirs

getKotlinDirs

getResourcesDirs

getGeneratedSourcesDirs

getAllDirs

getAllDirs

getAvailableDirs

getAvailableDirs

getCompileClassPath

getRuntimeClassPath

getAnnotationProcessorPath

getSourceType

hasOverlappingSourceDirs

getSourceTypes

outputContains

getOutputClassDirs

getOutputClassDir

getOutputResources

getSourceDependencies

contains

findResource

findResource

relativePath

toString

hashCode

equals

getBuildTaskName

getCompilerJavaHome

getCompilerArgs

getCompileTaskName

getProcessResourcesTaskName

getClassesTaskName

getTaskName