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

java.lang.Object
  extended by 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.
 org.netbeans.api.java.platform.JavaPlatform getJavaPlatform()
          Return server J2SE platform or null if the platform is unknown, not registered in the IDE.
 File[] getPlatformRoots()
          Return platform's root directories.
 Object getProperty(String name)
           
 Set getSupportedJavaPlatformVersions()
          Return a set of J2SE platform versions this J2EE platform can run with.
 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.
 boolean supportsProfiling()
          Is profiling supported by this J2EE platform?
 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.
Since:
1.6

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.

getSupportedJavaPlatformVersions

public Set getSupportedJavaPlatformVersions()
Return a set of J2SE platform versions this J2EE platform can run with. Versions should be specified as strings i.g. ("1.3", "1.4", etc.)

Returns:
set of J2SE platform versions this J2EE platform can run with.
Since:
1.9

supportsProfiling

public boolean supportsProfiling()
Is profiling supported by this J2EE platform?

Returns:
true, if profiling is supported, false otherwise.
Since:
1.9

getJavaPlatform

public org.netbeans.api.java.platform.JavaPlatform getJavaPlatform()
Return server J2SE platform or null if the platform is unknown, not registered in the IDE.

Returns:
server J2SE platform or null if the platform is unknown, not registered in the IDE.
Since:
1.9

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

getProperty

public Object getProperty(String name)

 

Built on March 27 2006.  |  Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.