org.netbeans.api.server
Class ServerInstance

java.lang.Object
  org.netbeans.api.server.ServerInstance

All Implemented Interfaces:

Lookup.Provider

public final class ServerInstance
extends Object
implements Lookup.Provider

The API representation of the single server instance. Class describes the instance and provides needed operations.

Currently this class is not reachable through API methods. This can change in future if we'll need to provide API in common server.

Method Summary

Node	getBasicNode() Returns the node representing the instance while configuring it.
JComponent	getCustomizer() Returns the component allowing the customization of the instance.
String	getDisplayName() Returns the display name of the instance.
Node	getFullNode() Returns the node representing the runtime instance.
Lookup	getLookup() Returns the lookup associated with this instance.
String	getServerDisplayName() Returns the display name of the server type to which this instance belongs.
boolean	isRemovable() Returns true if the instance can be removed by remove().
void	remove() Removes the instance.

Methods inherited from class java.lang.Object

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

Method Detail

getDisplayName

public String getDisplayName()

Returns the display name of the instance.

Returns:

the display name of the instance

getServerDisplayName

public String getServerDisplayName()

Returns the display name of the server type to which this instance belongs.

Returns:

the display name of the server type to which this instance belongs

getFullNode

public Node getFullNode()

Returns the node representing the runtime instance. The node should display instance status and provide actions to manage the server.

Returns:

the node representing the instance, may return null

getBasicNode

public Node getBasicNode()

Returns the node representing the instance while configuring it. The node should not display any status, actions or children.

Returns:

the node representing the instance, may return null

getCustomizer

public JComponent getCustomizer()

Returns the component allowing the customization of the instance. May return null.

Always called from Event Dispatch Thread.

Returns:

the component allowing the customization of the instance, may return null

remove

public void remove()

Removes the instance. No ServerInstanceProvider should return this instance once it is removed.

isRemovable

public boolean isRemovable()

Returns true if the instance can be removed by remove(). Otherwise returns false.

Returns:

true if the instance can be removed

getLookup

public Lookup getLookup()

Returns the lookup associated with this instance.

Specified by:

getLookup in interface Lookup.Provider

Returns:

the lookup associated with this instance

Since:

1.19