org.netbeans.modules.j2ee.deployment.plugins.api
Class J2eePlatformImpl

java.lang.Object
  org.netbeans.modules.j2ee.deployment.plugins.api.J2eePlatformImpl

public abstract class J2eePlatformImpl
extends Object

Base SPI interface for J2eePlatform. The 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_DISPLAY_NAME Display name property
static String	PROP_LIBRARIES Libraries property
static String	PROP_PLATFORM_ROOTS Platform roots property

Constructor Summary

J2eePlatformImpl()

Method Summary

void	addPropertyChangeListener(PropertyChangeListener l) Register a listener which will be notified when some of the platform's properties change.
void	firePropertyChange(String propName, Object oldValue, Object newValue) Fire PropertyChange to all registered PropertyChangeListeners.
abstract String	getDisplayName() Return platform's display name.
abstract Image	getIcon() Return an icon describing the platform.
abstract org.netbeans.spi.project.libraries.LibraryImplementation[]	getLibraries() Return platform's libraries.
abstract File[]	getPlatformRoots() Return platform's root directories.
abstract Set	getSupportedModuleTypes() Return a list of supported J2EE module types.
abstract Set	getSupportedSpecVersions() Return a list of supported J2EE specification versions.
abstract File[]	getToolClasspathEntries(String toolName) Return classpath for the specified tool.
abstract 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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_PLATFORM_ROOTS

public static final String PROP_PLATFORM_ROOTS

Platform roots property

See Also:

Constant Field Values

Constructor Detail

J2eePlatformImpl

public J2eePlatformImpl()

Method Detail

getLibraries

public abstract org.netbeans.spi.project.libraries.LibraryImplementation[] getLibraries()

Return platform's libraries.

Returns:

platform's libraries.

getDisplayName

public abstract String getDisplayName()

Return platform's display name.

Returns:

platform's display name.

getIcon

public abstract Image getIcon()

Return an icon describing the platform. This will be mostly the icon used for server instance nodes

Returns:

an icon describing the platform

getPlatformRoots

public abstract File[] getPlatformRoots()

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

Returns:

platform's root directories.

getToolClasspathEntries

public abstract 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 abstract 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.

getSupportedSpecVersions

public abstract 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 abstract 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 final 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 final void removePropertyChangeListener(PropertyChangeListener l)

Remove a listener registered previously.

Parameters:

l - listener which should be removed.

firePropertyChange

public final void firePropertyChange(String propName,
                                     Object oldValue,
                                     Object newValue)

Fire PropertyChange to all registered PropertyChangeListeners.

Parameters:

propName - property name.

oldValue - old value.

newValue - new value.