javax.ide.util
Class ID

java.lang.Object
  javax.ide.util.ID

public final class ID
extends java.lang.Object

Class used to identify objects. A ID is made up of the object type and a object name. In general, the object type is a generic type identifying similar objects and the object name is the specific name of the object. By convention, the object type identifier is a dash or dot separated string whose uniqueness comes from following the package naming scheme of an extension.

In general, an IDE has a set of objects that extensions need to get a hold of. Such objects, which include actions and views for example, implment the Identifiable interface and have an ID that uniquely identifies them.

Constructor Summary

ID(java.lang.String name)
Construct an ID with the specified name.

ID(java.lang.String type, java.lang.String name)
Constructor.

Method Summary

boolean	equals(java.lang.Object object)
java.lang.String	getName() Get the object name.
java.lang.String	getType() Get the object type identifier.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ID

public ID(java.lang.String type,
          java.lang.String name)

Constructor.

Parameters:

type - the object type. In general, the object type is a generic type identifying a class of objects. The type may be null.

By convention, the object type identifier is a dash or dot separated string whose uniqueness comes from following the package naming scheme of an extension.

name - the object name. In general, the object name is specific to the object instance. The name cannot be null.

ID

public ID(java.lang.String name)

Construct an ID with the specified name. The id type is undefined.

Method Detail

getType

public java.lang.String getType()

Get the object type identifier. The type may null.

By convention, the object type identifier is a dash or dot separated string whose uniqueness comes from following the package naming scheme of an extension.

Returns:

the type part of the object id.

getName

public java.lang.String getName()

Get the object name. In general, the object name is what identifies instances with the same type identifier. The name cannot be null.

Returns:

the name part of the object id.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object