org.netbeans.modules.j2ee.deployment.devmodules.api
Class J2eePlatform

java.lang.Object
  org.netbeans.modules.j2ee.deployment.devmodules.api.J2eePlatform

public final class J2eePlatform
extends Object

J2eePlatform describes the target environment J2EE applications are build against and subsequently deployed to. Each server instance defines its own J2EE platform.

Since:

1.5

Field Summary

static String	PROP_CLASSPATH Classpath property
static String	PROP_DISPLAY_NAME Display name property
static String	PROP_LIBRARIES Libraries property
static String	PROP_PLATFORM_ROOTS Platform roots property

Method Summary

void	addPropertyChangeListener(PropertyChangeListener l) Register a listener which will be notified when some of the platform's properties change.
File[]	getClasspathEntries() Return classpath entries.
String	getDisplayName() Return platform's display name.
Image	getIcon() Return platform's icon.
File[]	getPlatformRoots() Return platform's root directories.
Set	getSupportedModuleTypes() Return a list of supported J2EE module types.
Set	getSupportedSpecVersions() Return a list of supported J2EE specification versions.
File[]	getToolClasspathEntries(String toolName) Return classpath for the specified tool.
boolean	isToolSupported(String toolName) Specifies whether a tool of the given name is supported by this platform.
void	removePropertyChangeListener(PropertyChangeListener l) Remove a listener registered previously.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PROP_DISPLAY_NAME

public static final String PROP_DISPLAY_NAME

Display name property

See Also:

Constant Field Values

PROP_LIBRARIES

public static final String PROP_LIBRARIES

Libraries property

See Also:

Constant Field Values

PROP_CLASSPATH

public static final String PROP_CLASSPATH

Classpath property

See Also:

Constant Field Values

PROP_PLATFORM_ROOTS

public static final String PROP_PLATFORM_ROOTS

Platform roots property

See Also:

Constant Field Values

Method Detail

getClasspathEntries

public File[] getClasspathEntries()

Return classpath entries.

Returns:

classpath entries.

getToolClasspathEntries

public File[] getToolClasspathEntries(String toolName)

Return classpath for the specified tool.

Parameters:

toolName - tool's name e.g. "wscompile".

Returns:

classpath for the specified tool.

isToolSupported

public boolean isToolSupported(String toolName)

Specifies whether a tool of the given name is supported by this platform.

Parameters:

toolName - tool's name e.g. "wscompile".

Returns:

true if platform supports tool of the given name, false otherwise.

getDisplayName

public String getDisplayName()

Return platform's display name.

Returns:

platform's display name.

getIcon

public Image getIcon()

Return platform's icon.

Returns:

platform's icon.

getPlatformRoots

public File[] getPlatformRoots()

Return platform's root directories. This will be mostly server's installation directory.

Returns:

platform's root directories.

getSupportedSpecVersions

public Set getSupportedSpecVersions()

Return a list of supported J2EE specification versions. Use J2EE specification versions defined in the J2eeModule class.

Returns:

list of supported J2EE specification versions.

getSupportedModuleTypes

public Set getSupportedModuleTypes()

Return a list of supported J2EE module types. Use module types defined in the J2eeModule class.

Returns:

list of supported J2EE module types.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Register a listener which will be notified when some of the platform's properties change.

Parameters:

l - listener which should be added.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Remove a listener registered previously.

Parameters:

l - listener which should be removed.

toString

public String toString()

Overrides:

toString in class Object