All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.wizards.registry.ComponentDescription

java.lang.Object
   |
   +----com.sun.wizards.registry.ComponentDescription

public class ComponentDescription

extends Object

implements Serializable, Cloneable

ComponentDescription()

Creates a new install description.

ComponentDescription(String)

Creates a new component description with the specified GUID.

addDependentComponent(String, String, String)

addRequiredComponent(String, String, String)

containsDependentComponent(String, String, String)

containsRequiredComponent(String, String, String)

copy()

getBackwardCompatibleList()

Returns a list of versions this component is backward compatible with.

getData()

Returns application-specific data.

getData(String)

Returns an application-specific data value.

getDependentComponents()

Returns a representation of the components that depend upon this component.

getDependentComponents(RegistryService)

Get the ComponentDescription objects representing all components that depend upon this component.

getFederatedName()

Returns this component's federated name.

getGUID()

Returns the guid representing this component.

getInstallLocation()

Returns the install directory of this component.

getInstance()

Returns the instance id of this component.

getName()

Returns this component's name.

getRequiredComponents()

Returns a representation of the components that require this component.

getRequiredComponents(RegistryService)

Get the ComponentDescription objects representing all components that this component requires.

getUninstaller()

Returns the command used to uninstall this component.

getVersion()

Returns this component's version string.

isValidDescription()

Returns true if this ComponentDescription contains enough information to completely describe the component.

removeDependentComponent(ComponentDescription)

setBackwardCompatibleList(String)

Sets the list of versions this component is backward compatible with.

setData(String, Object)

Sets an application-specific key/value pair.

setDependentComponents(Hashtable)

Sets the list of components that require this component.

setFederatedName(String)

Sets this component's federated name.

setGUID(String)

Sets the GUID representing this component.

setInstallLocation(String)

Sets the install directory of this component.

setInstance(int)

Sets the instance id of this component.

setName(String)

Sets the name of this component.

setRequiredComponents(Hashtable)

Sets the list of components that this component requires.

setUninstaller(String)

Sets the command used to uninstall this component.

setVersion(String)

Sets this component's version string.

toString()

Converts this ComponentDescription to a string.

 public ComponentDescription()

Creates a new install description.

 public ComponentDescription(String guid)

Creates a new component description with the specified GUID.

Parameters:

guid - The Global Unique Identifier that specifies this component.

 public String getGUID()

Returns the guid representing this component.

Returns:

The Global Unique Identifier.

 public void setGUID(String guid)

Sets the GUID representing this component.

Parameters:

guid - The Global Unique Identifier that specifies this component.

 public String getFederatedName()

Returns this component's federated name.

Returns:

The federated name of this component.

 public void setFederatedName(String federatedName)

Sets this component's federated name.

Parameters:

federatedName - The abbreviated form of the component name.

 public String getVersion()

Returns this component's version string.

Returns:

The version string.

 public void setVersion(String version)

Sets this component's version string.

Parameters:

version - The version string of this component.

 public int getInstance()

Returns the instance id of this component.

 public void setInstance(int instance)

Sets the instance id of this component.

 public String getName()

Returns this component's name.

Returns:

The name of this component.

 public void setName(String name)

Sets the name of this component.

Parameters:

name - The name of this component.

 public String getInstallLocation()

Returns the install directory of this component.

Returns:

The install directory.

 public void setInstallLocation(String installLocation)

Sets the install directory of this component.

Parameters:

installLocation - The directory this component is installed in.

 public String getUninstaller()

Returns the command used to uninstall this component.

Returns:

The uninstall command.

 public void setUninstaller(String uninstaller)

Sets the command used to uninstall this component.

Parameters:

uninstaller - The uninstall command.

 public Hashtable getDependentComponents()

Returns a representation of the components that depend upon this component.

Returns:

The components that depend upon this one.

 public void setDependentComponents(Hashtable dependentComponents)

Sets the list of components that require this component. The format of the hashtable should be: guid:instance version

 public void addDependentComponent(String guid,
                                   String instance,
                                   String version)

 public Hashtable getRequiredComponents()

Returns a representation of the components that require this component.

Returns:

The components that require this component.

 public void setRequiredComponents(Hashtable requiredComponents)

Sets the list of components that this component requires.

Parameters:

requiredComponents - The list of components depending on this component.

 public void addRequiredComponent(String guid,
                                  String instance,
                                  String version)

 public void removeDependentComponent(ComponentDescription component)

 public boolean containsDependentComponent(String guid,
                                           String instance,
                                           String version)

 public boolean containsRequiredComponent(String guid,
                                          String instance,
                                          String version)

 public String getBackwardCompatibleList()

Returns a list of versions this component is backward compatible with.

 public void setBackwardCompatibleList(String backwardCompatible)

Sets the list of versions this component is backward compatible with.

 public Hashtable getData()

Returns application-specific data.

 public Object getData(String key)

Returns an application-specific data value.

 public void setData(String key,
                     Object value)

Sets an application-specific key/value pair.

 public boolean isValidDescription()

Returns true if this ComponentDescription contains enough information to completely describe the component.

 public String toString()

Converts this ComponentDescription to a string.

Overrides:

toString in class Object

 public Enumeration getDependentComponents(RegistryService registry)

Get the ComponentDescription objects representing all components that depend upon this component.

 public Enumeration getRequiredComponents(RegistryService registry)

Get the ComponentDescription objects representing all components that this component requires.

 public ComponentDescription copy()

All Packages  Class Hierarchy  This Package  Previous  Next  Index