org.netbeans.api.java.queries

Class SourceLevelQuery.Result

java.lang.Object

org.netbeans.api.java.queries.SourceLevelQuery.Result

Enclosing class:

SourceLevelQuery

public static final class SourceLevelQuery.Result
extends Object

Result of finding source level, encapsulating the answer as well as the ability to listen to it.

Since:

1.30

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener listener) Add a listener to changes of source level.
SourceLevelQuery.Profile	getProfile() Returns the required profile.
String	getSourceLevel() Get the source level.
void	removeChangeListener(ChangeListener listener) Remove a listener to changes of source level.
boolean	supportsChanges() Returns true if the result support updates and client may listen on it.

Methods inherited from class java.lang.Object

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

Method Detail

getSourceLevel

@CheckForNull
public String getSourceLevel()

Get the source level.

Returns:

a source level of the Java file, e.g. "1.3", "1.4", "1.5" or null if the source level is unknown. Even it is allowed for a SPI implementation to return a source level synonym e.g. "5" for "1.5" the returned value is always normalized.

getProfile

@NonNull
public SourceLevelQuery.Profile getProfile()

Returns the required profile.

Returns:

the required profile. If the profile is either unknown or unsupported by actual source level it returns the SourceLevelQuery.Profile.DEFAULT.

The JDK 8 provides three limited profiles (compact1, compact2, compact3) in addition to the full JDK. Each profile specifies a specific set of Java API packages and contains all of the APIs of the smaller profile, @see http://openjdk.java.net/jeps/161

Since:

1.47

addChangeListener

public void addChangeListener(@NonNull
                              ChangeListener listener)

Add a listener to changes of source level. If SourceLevelQuery.Result.supportsChanges() is false, the listener will never be notified although SourceLevelQuery.Result.getSourceLevel() may change from call to call.

Parameters:

listener - a listener to add

removeChangeListener

public void removeChangeListener(@NonNull
                                 ChangeListener listener)

Remove a listener to changes of source level.

Parameters:

listener - a listener to add

supportsChanges

public boolean supportsChanges()

Returns true if the result support updates and client may listen on it. If false client should always ask again to obtain current value. The results created for values returned by the SourceLevelQueryImplementation do not support listening.

Returns:

true if the result supports changes and listening