public interface Key extends Comparable<Key>, Iterable<Key>, Cloneable, Serializable
The GNU Lesser General Public License for details.
Modifier and Type | Method and Description |
---|---|
void |
addAll(Key key)
Adds the specified element to this set if it is not already present.
|
void |
blur(int by,
RestrictionType restrict)
Widen the range of the verses/keys in this list.
|
boolean |
canHaveChildren()
Returns false if the receiver is a leaf node and can not have children.
|
void |
clear()
Removes all of the elements from this set (optional operation).
|
Key |
clone()
This needs to be declared here so that it is visible as a method on a
derived Key.
|
boolean |
contains(Key key)
Returns true if this set contains the specified element.
|
boolean |
equals(Object obj)
This needs to be declared here so that it is visible as a method on a
derived Key.
|
Key |
get(int index)
Gets a key from a specific point in this list of children.
|
int |
getCardinality()
Returns the number of elements in this set (its cardinality).
|
int |
getChildCount()
Returns the number of children that this node has.
|
String |
getName()
A Human readable version of the Key.
|
String |
getName(Key base)
Translate the Key into a human readable string, with the assumption that
the specified Key has just been output, so if we are in the same region,
we do not need to display the region name, and so on.
|
String |
getOsisID()
The OSIS defined id specification for this Key.
|
String |
getOsisRef()
The OSIS defined reference specification for this Key.
|
Key |
getParent()
All keys have parents unless they are the root of a Key.
|
String |
getRootName()
A Human readable version of the Key's top level name.
|
int |
hashCode()
This needs to be declared here so that it is visible as a method on a
derived Key.
|
int |
indexOf(Key that)
Reverse a Key into the position the key holds in the list of children
|
boolean |
isEmpty()
Does this Key have 0 members
|
void |
removeAll(Key key)
Removes the specified elements from this set if it is present.
|
void |
retainAll(Key key)
Removes all but the specified element from this set.
|
compareTo
String getName()
String getName(Key base)
base
- The key to use to cut down unnecessary output.String getRootName()
String getOsisRef()
String getOsisID()
Key getParent()
boolean canHaveChildren()
int getChildCount()
int getCardinality()
This method is potentially expensive, as it often requires cycling through all the keys in the set.
boolean isEmpty()
boolean contains(Key key)
key
- element whose presence in this set is to be tested.void addAll(Key key)
key
- element to be added to this set.NullPointerException
- if the specified element is nullvoid removeAll(Key key)
key
- object to be removed from this set, if present.NullPointerException
- if the specified element is nullvoid retainAll(Key key)
key
- object to be left in this set.NullPointerException
- if the specified element is nullvoid clear()
Key get(int index)
index
- The index of the Key to retrieveIndexOutOfBoundsException
int indexOf(Key that)
that
- The Key to findvoid blur(int by, RestrictionType restrict)
by
- The number of verses/keys to widen byrestrict
- How should we restrict the blurring?Passage
Key clone()
boolean equals(Object obj)