|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object blackboard.persist.Id blackboard.persist.UnsetId
public class UnsetId
The UnsetId
class represents an unset data object Id
.
Field Summary | |
---|---|
static java.lang.String |
TO_STR
|
Fields inherited from class blackboard.persist.Id |
---|
UNSET_ID |
Constructor Summary | |
---|---|
UnsetId()
Default constructor |
Method Summary | |
---|---|
int |
compareTo(java.lang.Object obj)
The sole method of the Comparable interface. |
boolean |
equals(java.lang.Object obj)
Overrides the equals() method in
Object to provide a simple way to compare two UnsetId
s. |
int |
hashCode()
Returns a hash code value for the object. |
boolean |
isSet()
Determines if this UnsetId has been set. |
void |
setContainer(Container container)
Override Id.setContainer(Container) to prevent the setting of the
container value within an UnsetId . |
void |
setDataType(DataType dataType)
Override Id.setDataType(DataType) to prevent the setting of the
data type value within an UnsetId . |
java.lang.String |
toExternalString()
Converts this UnsetId into its String representation. |
java.lang.String |
toString()
Converts this UnsetId into its String representation. |
Methods inherited from class blackboard.persist.Id |
---|
assertIsSet, assertMatchesContainer, assertMatchesDataType, generateId, generateId, generateId, getContainer, getDataType, hasSameContainer, hasSameDataType, load, matchesContainer, matchesDataType, newId |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String TO_STR
Constructor Detail |
---|
public UnsetId()
Method Detail |
---|
public boolean isSet()
UnsetId
has been set.
isSet
in class Id
UnsetId
)public boolean equals(java.lang.Object obj)
equals()
method in
Object
to provide a simple way to compare two UnsetId
s.
equals
in class Id
obj
- the object to be compared.
UnsetId
-- two
UnsetId
s are always equal.public int compareTo(java.lang.Object obj) throws java.lang.ClassCastException
Comparable
interface.
Used for sorting and natural-ordering algorithms.
compareTo
in interface java.lang.Comparable
compareTo
in class Id
obj
- the object to be compared to.
UnsetId
-- two
UnsetId
s are always equal.
java.lang.ClassCastException
- thrown if the specified object's type
prevents it from being compared to this Objectpublic int hashCode()
java.util.Hashtable
hashCode
in class Id
UnsetId
instances are equal and therefore always return the same
hash value.public java.lang.String toExternalString()
UnsetId
into its String representation.
toExternalString
in class Id
UnsetId
.Id.toString()
,
BbPersistenceManager.generateId(DataType,String)
,
Container.generateId(DataType,String)
public java.lang.String toString()
UnsetId
into its String representation.
toString
in class Id
UnsetId
.Id.toExternalString()
public void setContainer(Container container)
Id.setContainer(Container)
to prevent the setting of the
container value within an UnsetId
. An UnsetId
is
never associated with a container and therefore the container value of an
UnsetId
is always null.
setContainer
in class Id
container
- the Container
to associate with this id. Can not
be null.
RunTimeException
- always thrown if calledpublic void setDataType(DataType dataType)
Id.setDataType(DataType)
to prevent the setting of the
data type value within an UnsetId
. An UnsetId
is
has a hard-coded "null" data type that can not be changed.
setDataType
in class Id
dataType
- the DataType
to associate with this Id. Can not be
null. If no data type is presently desired pass in DataType.NULL_DATA_TYPE
.
RunTimeException
- always thrown if calledDataType.NULL_DATA_TYPE
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |