|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.commands.common.HandleObject
org.eclipse.core.commands.common.NamedHandleObject
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
.
Field Summary | |
---|---|
protected String |
description
The description for this handle. |
protected String |
name
The name of this handle. |
Fields inherited from class org.eclipse.core.commands.common.HandleObject |
---|
defined, id, string |
Constructor Summary | |
---|---|
protected |
NamedHandleObject(String id)
Constructs a new instance of NamedHandleObject . |
Method Summary | |
---|---|
String |
getDescription()
Returns the description for this handle. |
String |
getName()
Returns the name for this handle. |
Methods inherited from class org.eclipse.core.commands.common.HandleObject |
---|
equals, getId, hashCode, isDefined, toString, undefine |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
protected String description
null
if
the handle is undefined or has no description.
protected String name
null
unless the handle is undefined.
Constructor Detail |
protected NamedHandleObject(String id)
NamedHandleObject
.
id
- The identifier for this handle; must not be null
.Method Detail |
public final String getDescription() throws NotDefinedException
null
if there is no
description.
NotDefinedException
- If the handle is not currently defined.public final String getName() throws NotDefinedException
null
.
NotDefinedException
- If the handle is not currently defined.
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.