org.netbeans.spi.java.platform.support

Class ForwardingJavaPlatform

java.lang.Object

org.netbeans.api.java.platform.JavaPlatform

org.netbeans.spi.java.platform.support.ForwardingJavaPlatform

public class ForwardingJavaPlatform
extends JavaPlatform

A JavaPlatform forwarding calls to a delegate.

Since:

1.41

Field Summary

Fields

Modifier and Type	Field and Description
protected JavaPlatform	delegate

Fields inherited from class org.netbeans.api.java.platform.JavaPlatform

PROP_DISPLAY_NAME, PROP_JAVADOC_FOLDER, PROP_SOURCE_FOLDER, PROP_SYSTEM_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
ForwardingJavaPlatform(JavaPlatform delegate)

Method Summary

Modifier and Type	Method and Description
FileObject	findTool(String toolName) Gets the platform tool executable.
ClassPath	getBootstrapLibraries() Returns a ClassPath, which represents bootstrap libraries for the runtime environment.
String	getDisplayName()
Collection<FileObject>	getInstallFolders() Retrieves a collection of FileObjects of one or more folders where the Platform is installed.
List<URL>	getJavadocFolders() Returns the locations of the Javadoc for this platform or empty collection if the location is not set or invalid
Map<String,String>	getProperties() Gets some ad-hoc properties defined for this platform.
ClassPath	getSourceFolders() Returns the locations of the source of platform or empty collection when the location is not set or is invalid
Specification	getSpecification() Returns specification of the Java SDK
ClassPath	getStandardLibraries() Returns libraries recognized by default by the platform.
String	getVendor() Returns the vendor of the Java SDK

Methods inherited from class org.netbeans.api.java.platform.JavaPlatform

addPropertyChangeListener, firePropertyChange, getDefault, getSystemProperties, isValid, removePropertyChangeListener, setSystemProperties

Methods inherited from class java.lang.Object

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

Field Detail

delegate

protected final JavaPlatform delegate

Constructor Detail

ForwardingJavaPlatform

public ForwardingJavaPlatform(@NonNull
                              JavaPlatform delegate)

Method Detail

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class JavaPlatform

Returns:

a descriptive, human-readable name of the platform

getProperties

public Map<String,String> getProperties()

Description copied from class: JavaPlatform

Gets some ad-hoc properties defined for this platform. The precise set of properties is not specified.

Implementations are however advised to include the key platform.ant.name if they wish to be used in Ant builds; the value default_platform is conventionally associated with the default platform.

Specified by:

getProperties in class JavaPlatform

Returns:

some properties

getBootstrapLibraries

public ClassPath getBootstrapLibraries()

Description copied from class: JavaPlatform

Returns a ClassPath, which represents bootstrap libraries for the runtime environment. The Bootstrap libraries include libraries in JRE's extension directory, if there are any.

Specified by:

getBootstrapLibraries in class JavaPlatform

Returns:

ClassPath representing the bootstrap libs

getStandardLibraries

public ClassPath getStandardLibraries()

Description copied from class: JavaPlatform

Returns libraries recognized by default by the platform. Usually it corresponds to contents of CLASSPATH environment variable.

Specified by:

getStandardLibraries in class JavaPlatform

getVendor

public String getVendor()

Description copied from class: JavaPlatform

Returns the vendor of the Java SDK

Specified by:

getVendor in class JavaPlatform

Returns:

String

getSpecification

public Specification getSpecification()

Description copied from class: JavaPlatform

Returns specification of the Java SDK

Specified by:

getSpecification in class JavaPlatform

Returns:

Specification

getInstallFolders

public Collection<FileObject> getInstallFolders()

Description copied from class: JavaPlatform

Retrieves a collection of FileObjects of one or more folders where the Platform is installed. Typically it returns one folder, but in some cases there can be more of them.

Specified by:

getInstallFolders in class JavaPlatform

Returns:

collection of installation folders (should be nonempty unless platform is broken)

findTool

public FileObject findTool(String toolName)

Description copied from class: JavaPlatform

Gets the platform tool executable.

Specified by:

findTool in class JavaPlatform

Parameters:

toolName - the tool platform independent tool name.

Returns:

file representing the tool executable, or null if the tool can not be found

getSourceFolders

public ClassPath getSourceFolders()

Description copied from class: JavaPlatform

Returns the locations of the source of platform or empty collection when the location is not set or is invalid

Specified by:

getSourceFolders in class JavaPlatform

Returns:

ClassPath never returns null

getJavadocFolders

public List<URL> getJavadocFolders()

Description copied from class: JavaPlatform

Returns the locations of the Javadoc for this platform or empty collection if the location is not set or invalid

Specified by:

getJavadocFolders in class JavaPlatform

Returns:

(non-null) list of locations