|
3.2.4: 2013-12-06 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
O
- The type of object that the key referencespublic interface ObjectKey<O>
Instances of object keys should be something that uniquely
identifies an object that has been defined by an extension.
Object keys are mainly used to lookup in which file a
certain object has been defined
(see ExtensionsManager.getFileByObjectKey(ObjectKey)
)
and/or to get information about the object itself
(see ExtensionsFile.getObjectForKey(ObjectKey)
)
It is up to the actual implementations to decide what actually
makes up a key that can be used to identify an object. Implementors
of this interface should implement equals()
and
hashCode()
methods to only match with it's
own class. Implementations should be immutable.
ExtensionsManager.getFileByObjectKey(ObjectKey)
,
ExtensionsFile.getObjectForKey(ObjectKey)
Method Summary | |
---|---|
String |
toDescription()
Get a string description of the key that is suitable for use in (error) messages to users. |
Method Detail |
---|
String toDescription()
|
3.2.4: 2013-12-06 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |