org.netbeans.modules.gradle.api

Class NbGradleProject

java.lang.Object

org.netbeans.modules.gradle.api.NbGradleProject

public final class NbGradleProject
extends Object

Facade object for NetBeans Gradle project internals, with some convenience methods.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NbGradleProject.LoadOptions Describes options for loading a Gradle project.
static class	NbGradleProject.Quality As loading a Gradle project information into the memory could be a time consuming task each the Gradle Plugin uses heuristics and offline evaluation of a project in order to provide optimal responsiveness.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CODENAME_BASE
static String	GRADLE_PLUGIN_TYPE
static String	GRADLE_PROJECT_TYPE
static String	PROP_PROJECT_INFO This property is fired to change on every project reload.
static String	PROP_RESOURCES This property is fired when a project watched resource is changed.

Method Summary

Modifier and Type	Method and Description
static void	addPropertyChangeListener(Project project, PropertyChangeListener l) Convenient method to add a Property Listener to a Gradle project.
void	addPropertyChangeListener(PropertyChangeListener propertyChangeListener)
Lookup	curretLookup() Provides full lookup of the currently loaded project state.
static void	fireGradleProjectReload(Project prj)
static NbGradleProject	get(Project project) Retrieves the watcher for the given project.
NbGradleProject.Quality	getAimedQuality() The requested information on this project.
long	getEvaluateTime() Returns the time the project was evaluated.
GradleFiles	getGradleFiles() Returns accessor for Gradle project files.
static ImageIcon	getIcon()
Preferences	getPreferences(boolean shared)
static Preferences	getPreferences(Project project, boolean shared)
NbGradleProject.Quality	getQuality() Return the actual Quality information on the currently loaded Project.
static Icon	getWarningIcon()
boolean	isGradleProjectLoaded()
boolean	isUnloadable() The project is unloadable if it's actual quality is worse than NbGradleProject.Quality.SIMPLE.
static NbGradleProject.LoadOptions	loadOptions(NbGradleProject.Quality aim) Creates a NbGradleProject.LoadOptions object to be used with NbGradleProject.toQuality(org.netbeans.modules.gradle.api.NbGradleProject.LoadOptions).
<T> T	projectLookup(Class<T> clazz)
Lookup	refreshableProjectLookup() Returns a Lookup that tracks potential project reloads.
static void	removePropertyChangeListener(Project project, PropertyChangeListener l) Convenient method to remove a Property Listener from a Gradle project.
void	removePropertyChangeListener(PropertyChangeListener propertyChangeListener)
CompletionStage<NbGradleProject>	toQuality(NbGradleProject.LoadOptions options) Unlike NbGradleProject.toQuality(java.lang.String, org.netbeans.modules.gradle.api.NbGradleProject.Quality, boolean), this method loads the project, if the project files have changed since the last load.
CompletionStage<NbGradleProject>	toQuality(String reason, NbGradleProject.Quality q, boolean forceLoad) Attempts to refresh the project to at least the desired quality.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

GRADLE_PROJECT_TYPE

public static final String GRADLE_PROJECT_TYPE

See Also:

Constant Field Values

GRADLE_PLUGIN_TYPE

public static final String GRADLE_PLUGIN_TYPE

See Also:

Constant Field Values

PROP_PROJECT_INFO

public static final String PROP_PROJECT_INFO

This property is fired to change on every project reload.

See Also:

Constant Field Values

PROP_RESOURCES

public static final String PROP_RESOURCES

This property is fired when a project watched resource is changed. E.g. a previously non existent source root appears.

See Also:

Constant Field Values

CODENAME_BASE

public static final String CODENAME_BASE

See Also:

Constant Field Values

Method Detail

isGradleProjectLoaded

public boolean isGradleProjectLoaded()

curretLookup

public Lookup curretLookup()

Provides full lookup of the currently loaded project state. This Lookup does NOT refreshes as project is reload, the client must eventually watch NbGradleProject.PROP_PROJECT_INFO property change and obtain a fresh lookup.

Returns:

Lookup that contains the current metadata for the project.

projectLookup

public <T> T projectLookup(Class<T> clazz)

refreshableProjectLookup

public Lookup refreshableProjectLookup()

Returns a Lookup that tracks potential project reloads. Always delegates to the latest loaded model and project Lookup adjusted for applied plugins etc.

Use this Lookup in preference to NbGradleProject.projectLookup(java.lang.Class<T>), if you need to adapt for changes e.g. after script reload.

Returns:

Lookup instance.

Since:

2.28

getQuality

public NbGradleProject.Quality getQuality()

Return the actual Quality information on the currently loaded Project.

Returns:

the information Quality of the project data;

getAimedQuality

public NbGradleProject.Quality getAimedQuality()

The requested information on this project. Mostly FALLBACK or FULL.

Returns:

the information Quality requested.

isUnloadable

public boolean isUnloadable()

The project is unloadable if it's actual quality is worse than NbGradleProject.Quality.SIMPLE.

Returns:

true if the project is unloadable.

getEvaluateTime

public long getEvaluateTime()

Returns the time the project was evaluated. If the project has not been loaded at least in its 'fallback' state, it returns a negative value.

Returns:

evaluation time of the project.

toQuality

@NonNull
public CompletionStage<NbGradleProject> toQuality(@NullAllowed
                                                           String reason,
                                                           @NonNull
                                                           NbGradleProject.Quality q,
                                                           boolean forceLoad)

Attempts to refresh the project to at least the desired quality. The project information may be reloaded, if the project is currently loaded with lower NbGradleProject.Quality than q. If forceLoad is true, the project reloads even if the q is worse quality than the current NbGradleProject.getQuality() level. Reason for the reload may be specified: if the reload takes some time (i.e. executing Gradle build), the IDE may use the reason text to annotate the ongoing progress.

The returned CompletionStage may complete in this thread, or asynchronously in an unspecified thread.

Note that the loading may fail, so the returned Quality may be less than requested. For example if the project is not trusted, its Gradle build will not be executed, so the returned quality can be NbGradleProject.Quality.EVALUATED.

Parameters:

reason - reason for reload, may be null.

q - the desired quality of project information

forceLoad - force load even though the current info quality is sufficient.

Returns:

CompletionStage with the reloaded project. Use CompletionStage.toCompletableFuture().get() to block waiting for the result.

Since:

2.11

loadOptions

public static NbGradleProject.LoadOptions loadOptions(NbGradleProject.Quality aim)

Creates a NbGradleProject.LoadOptions object to be used with NbGradleProject.toQuality(org.netbeans.modules.gradle.api.NbGradleProject.LoadOptions).

Parameters:

aim - the target quality

Returns:

options object.

Since:

2.43

toQuality

@NonNull
public CompletionStage<NbGradleProject> toQuality(NbGradleProject.LoadOptions options)

Unlike NbGradleProject.toQuality(java.lang.String, org.netbeans.modules.gradle.api.NbGradleProject.Quality, boolean), this method loads the project, if the project files have changed since the last load. If project definition files did not change,

Parameters:

options - load options and requiremens.

Returns:

Future with the result project.

Since:

2.43

getPreferences

public Preferences getPreferences(boolean shared)

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener propertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener propertyChangeListener)

get

public static NbGradleProject get(Project project)

Retrieves the watcher for the given project. Usually the project watcher can be retrieved from the project Lookup. This implementation does not use the project Lookup, so it can be used inside of the constructors of ProjectServiceProvider implementations.

Parameters:

project - the project to query

Returns:

the watcher of the project or null if the given project is not a Gradle project.

getGradleFiles

public GradleFiles getGradleFiles()

Returns accessor for Gradle project files. Note that the returned instance is immutable, possibly lazy-initialized. A change (creation, removal) to project files will not be reflected by the GradleFiles instance, but this method may return a new instance.

Returns:

files accessor.

Since:

2.24

toString

public String toString()

Overrides:

toString in class Object

getIcon

public static ImageIcon getIcon()

getWarningIcon

public static final Icon getWarningIcon()

addPropertyChangeListener

public static void addPropertyChangeListener(Project project,
                                             PropertyChangeListener l)

Convenient method to add a Property Listener to a Gradle project.

Parameters:

project -

l -

removePropertyChangeListener

public static void removePropertyChangeListener(Project project,
                                                PropertyChangeListener l)

Convenient method to remove a Property Listener from a Gradle project.

Parameters:

project -

l -

fireGradleProjectReload

public static void fireGradleProjectReload(Project prj)

getPreferences

public static Preferences getPreferences(Project project,
                                         boolean shared)