Package org.eclipse.core.commands.common
Class NamedHandleObject
java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.core.commands.common.HandleObject
org.eclipse.core.commands.common.NamedHandleObject
- All Implemented Interfaces:
IIdentifiable
A handle object that carries with it a name and a description. This type of
handle object is quite common across the commands code base. For example,
Command, Context and Scheme.- Since:
- 3.1
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringThe description for this handle.protected StringThe name of this handle.Fields inherited from class org.eclipse.core.commands.common.HandleObject
defined, id, string -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructs a new instance ofNamedHandleObject. -
Method Summary
Modifier and TypeMethodDescriptionReturns the description for this handle.getName()Returns the name for this handle.Methods inherited from class org.eclipse.core.commands.common.HandleObject
equals, getId, hashCode, isDefined, toString, undefineMethods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
-
Field Details
-
description
The description for this handle. This value may benullif the handle is undefined or has no description. -
name
The name of this handle. This valud should not benullunless the handle is undefined.
-
-
Constructor Details
-
NamedHandleObject
Constructs a new instance ofNamedHandleObject.- Parameters:
id- The identifier for this handle; must not benull.
-
-
Method Details
-
getDescription
Returns the description for this handle.- Returns:
- The description; may be
nullif there is no description. - Throws:
NotDefinedException- If the handle is not currently defined.
-
getName
Returns the name for this handle.- Returns:
- The name for this handle; never
null. - Throws:
NotDefinedException- If the handle is not currently defined.
-