GradleBaseProject (Gradle Projects)

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

All Implemented Interfaces:

Serializable, ModuleSearchSupport
```
public final class GradleBaseProject
extends Object
implements Serializable, ModuleSearchSupport
```
This object holds the basic information of the Gradle project.
Note: Caching / storing this object inn a member field is discouraged. Use GradleBaseProject.get(Project) instead.

Since:

1.0

See Also:

org.gradle.api.Project, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String PRIVATE_TASK_GROUP

Fields
Modifier and Type	Field and Description
`static String`	`PRIVATE_TASK_GROUP`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Set<GradleDependency.ModuleDependency>`	`findModules(String gav)` Search for module dependencies, matches the given filter criteria.
`Set<GradleDependency.ModuleDependency>`	`findModules(String group, String artifact, String version)` Search for module dependencies, matches the given filter criteria.
`String`	`findProjectGav(String projectPath)` Finds a GAV for the given project.
`static GradleBaseProject`	`get(Project project)` Retrieve the actual GradleBaseProject from the given NetBeans `project` lookup.
`Set<File>`	`getBuildClassPath()`
`File`	`getBuildDir()`
`Map<String,GradleConfiguration>`	`getConfigurations()`
`String`	`getDescription()`
`String`	`getDisplayName()`
`Set<File>`	`getGradleClassPath()` The classpath used to
`String`	`getGroup()`
`Map<String,File>`	`getIncludedBuilds()`
`String`	`getLicense()` Returns the license identifier used in this Gradle project.
`String`	`getName()` This Gradle project name.
`String`	`getNetBeansProperty(String key)` Return the value of the property defined `netbeans.<key>` as in this Gradle project or inherited from the root project.
`Set<File>`	`getOutputPaths()`
`String`	`getParentName()`
`String`	`getPath()`
`Set<String>`	`getPlugins()` The set of Gradle plugin ids used applied in this project.
`Set<GradleReport>`	`getProblems()` Return the list of problems reported by Gradle on project inspection.
`Set<GradleDependency.ProjectDependency>`	`getProjectDependencies()`
`File`	`getProjectDir()`
`File`	`getRootDir()` The project directory of the root project.
`String`	`getStatus()`
`Map<String,File>`	`getSubProjects()` Returns the sub-project of this project, in a map as Gradle project path and project directory pairs.
`GradleTask`	`getTaskByName(String name)`
`Set<String>`	`getTaskGroups()`
`Set<String>`	`getTaskNames()`
`List<GradleTask>`	`getTaskPredecessors(GradleTask gt, boolean directs)` For a given task, lists all predecessors of the task within the current project.
`List<GradleTask>`	`getTasks()`
`List<GradleTask>`	`getTasks(String group)`
`String`	`getVersion()`
`boolean`	`hasPlugins(String... plugins)`
`boolean`	`isResolved()` Returns `true` if all resolvable configurations are resolved.
`boolean`	`isRoot()` Returns true if the project directory is the same as the root project's project directory, in short if this project is a root project.
`boolean`	`isRootOf(GradleBaseProject other)`
`boolean`	`isSibling(GradleBaseProject other)`
`boolean`	`isTaskInstanceOf(String name, String gradleFQN)` Determines if a task is a subtype of a certain Gradle type.
`boolean`	`isVersionSpecified()`
`String`	`toString()`

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

- Field Detail
  - PRIVATE_TASK_GROUP
```
public static final String PRIVATE_TASK_GROUP
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
public String getName()
```
    This Gradle project name.
    
    Returns:
    
    the name of the project
  - getPath
```
public String getPath()
```
  - getStatus
```
public String getStatus()
```
  - getParentName
```
public String getParentName()
```
  - getGroup
```
public String getGroup()
```
  - getDescription
```
public String getDescription()
```
  - getDisplayName
```
public String getDisplayName()
```
  - isVersionSpecified
```
public boolean isVersionSpecified()
```
  - getVersion
```
public String getVersion()
```
  - getBuildDir
```
public File getBuildDir()
```
  - getOutputPaths
```
public Set<File> getOutputPaths()
```
  - getProjectDir
```
public File getProjectDir()
```
  - getPlugins
```
public Set<String> getPlugins()
```
    The set of Gradle plugin ids used applied in this project.
    
    Returns:
    
    the set of applied plugins
  - getRootDir
```
public File getRootDir()
```
    The project directory of the root project.
    
    Returns:
    
    the root project directory.
  - getGradleClassPath
```
public Set<File> getGradleClassPath()
```
    The classpath used to
    
    Returns:
  - getBuildClassPath
```
public Set<File> getBuildClassPath()
```
  - getIncludedBuilds
```
public Map<String,File> getIncludedBuilds()
```
  - getProblems
```
public Set<GradleReport> getProblems()
```
    Return the list of problems reported by Gradle on project inspection. In an ideal case that should be an empty set.
    
    Returns:
    
    Gradle reported problems during inspection.
    
    Since:
    
    2.27
  - isRoot
```
public boolean isRoot()
```
    Returns true if the project directory is the same as the root project's project directory, in short if this project is a root project.
    
    Returns:
    
    true for root Gradle projects
  - getNetBeansProperty
```
public String getNetBeansProperty(String key)
```
    Return the value of the property defined netbeans.<key> as in this Gradle project or inherited from the root project.
    
    Parameters:
    
    key - the property name after the netbeans. prefix.
    
    Returns:
    
    the property value or null if it is not defined.
  - getLicense
```
public String getLicense()
```
    Returns the license identifier used in this Gradle project. It is determined by the netbeans.license property of the project, if that's not found license property is used. If even that would be undefined the license "default" is used.
    
    Returns:
    
    the project defined license or default if no license has been specified.
  - getSubProjects
```
public Map<String,File> getSubProjects()
```
    Returns the sub-project of this project, in a map as Gradle project path and project directory pairs. In the current Gradle implementation only root project can have sub-projects.
    
    Returns:
    
    the map of sub-projects.
  - findProjectGav
```
public String findProjectGav(@NonNull
                             String projectPath)
```
    Finds a GAV for the given project. Returns null if the project path is not known (it is not referenced anywhere by this project), or has no known GAV. The project's own GAV should be always present, if defined by the project file(s).
    
    Parameters:
    
    projectPath - Gradle project path
    
    Returns:
    
    GAV coordinates, or null
    
    Since:
    
    2.27
  - getTaskGroups
```
public Set<String> getTaskGroups()
```
  - getTasks
```
public List<GradleTask> getTasks(String group)
```
  - getTasks
```
public List<GradleTask> getTasks()
```
  - getTaskNames
```
public Set<String> getTaskNames()
```
  - getTaskByName
```
public GradleTask getTaskByName(String name)
```
  - getTaskPredecessors
```
public List<GradleTask> getTaskPredecessors(GradleTask gt,
                                            boolean directs)
```
    For a given task, lists all predecessors of the task within the current project. If tasks from other projects are referenced, they are returned as mock objects, that have no group and no description and no dependencies.
    The result is partially sorted so that dependencies always precede the dependent task.
    
    Parameters:
    
    gt - gradle task to inspect
    
    directs - if true, only direct predecessors are returned
    
    Returns:
    
    list of predecessor tasks.
    
    Since:
    
    2.28
  - isTaskInstanceOf
```
public boolean isTaskInstanceOf(String name,
                                String gradleFQN)
```
    Determines if a task is a subtype of a certain Gradle type. User-defined tasks may define different names, but the can be identified by the gradle type they extend or implement. Use fully qualified API class names for gradleFQN parameter.
    
    Parameters:
    
    gradleFQN - the fully qualified type name
    
    Returns:
    
    true, if the task type matches.
    
    Since:
    
    2.28
  - getConfigurations
```
public Map<String,GradleConfiguration> getConfigurations()
```
  - getProjectDependencies
```
public Set<GradleDependency.ProjectDependency> getProjectDependencies()
```
  - hasPlugins
```
public boolean hasPlugins(String... plugins)
```
  - findModules
```
public Set<GradleDependency.ModuleDependency> findModules(String group,
                                                          String artifact,
                                                          String version)
```
    Description copied from interface: ModuleSearchSupport
    
    Search for module dependencies, matches the given filter criteria. Specifying null for any of the parameters would mean match all for that parameter.
    
    Specified by:
    
    findModules in interface ModuleSearchSupport
    
    Parameters:
    
    group - regexp matcher for the group part.
    
    artifact - regexp matcher for the artifact part.
    
    version - regexp matcher for the version part.
    
    Returns:
    
    Set of module dependencies that match the criteria.
    
    See Also:
    
    Pattern
  - findModules
```
public Set<GradleDependency.ModuleDependency> findModules(String gav)
                                                   throws IllegalArgumentException
```
    Description copied from interface: ModuleSearchSupport
    
    Search for module dependencies, matches the given filter criteria. The format of the criteria is a colon separated string: "<group>:<atrifact>:<version>", empty pattern mean match all for that part.
    
    Specified by:
    
    findModules in interface ModuleSearchSupport
    
    Parameters:
    
    gav - the filter criteria in string form
    
    Returns:
    
    Set of module dependencies that match the criteria.
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    ModuleSearchSupport.findModules(java.lang.String, java.lang.String, java.lang.String)
  - isResolved
```
public boolean isResolved()
```
    Returns true if all resolvable configurations are resolved.
    
    Returns:
    
    true - if all resolvable configurations are resolved.
  - isRootOf
```
public boolean isRootOf(GradleBaseProject other)
```
  - isSibling
```
public boolean isSibling(GradleBaseProject other)
```
  - get
```
public static GradleBaseProject get(Project project)
```
    Retrieve the actual GradleBaseProject from the given NetBeans project lookup. If the project is not a Gradle project it returns null. It always returns a non-null value for a Gradle project.
    
    Parameters:
    
    project - a NetBeans project
    
    Returns:
    
    the basic Gradle project info stored for the given project or null for non-Gradle projects.
    
    See Also:
    
    NbGradleProject.Quality
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class GradleBaseProject

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRIVATE_TASK_GROUP

Method Detail

getName

getPath

getStatus

getParentName

getGroup

getDescription

getDisplayName

isVersionSpecified

getVersion

getBuildDir

getOutputPaths

getProjectDir

getPlugins

getRootDir

getGradleClassPath

getBuildClassPath

getIncludedBuilds

getProblems

isRoot

getNetBeansProperty

getLicense

getSubProjects

findProjectGav

getTaskGroups

getTasks

getTasks

getTaskNames

getTaskByName

getTaskPredecessors

isTaskInstanceOf

getConfigurations

getProjectDependencies

hasPlugins

findModules

findModules

isResolved

isRootOf

isSibling

get

toString