|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.passage.AbstractKeyList
org.crosswire.jsword.passage.SetKeyList
public class SetKeyList
A Key that uses a Set of Keys as it's store of data.
for license details.
The copyright to this program is held by it's authors.
Field Summary | |
---|---|
private List |
list
The Set that we are proxying to |
private static Logger |
log
The log stream |
private Key |
parent
The parent of this key |
Constructor Summary | |
---|---|
SetKeyList(Set set)
Simple ctor |
|
SetKeyList(Set set,
Key parent)
Simple ctor |
|
SetKeyList(Set set,
Key parent,
String name)
Simple ctor |
|
SetKeyList(Set set,
String name)
Simple ctor |
Method Summary | |
---|---|
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 true if the receiver is a leaf node and can not have children. |
void |
clear()
Removes all of the elements from this set (optional operation). |
boolean |
contains(Key key)
Returns true if this set contains the specified element. |
boolean |
equals(Object obj)
|
Key |
get(int index)
Gets a key from a specific point in this list. |
int |
getChildCount()
Returns the number of elements in this set (its cardinality). |
Key |
getParent()
All keys have parents unless they are the root of a Key. |
int |
hashCode()
|
int |
indexOf(Key that)
Reverse a Key into the position the key holds in the list |
boolean |
isEmpty()
Does this Passage have 0 members |
Iterator |
iterator()
|
void |
removeAll(Key key)
Removes the specified elements from this set if it is present. |
Methods inherited from class org.crosswire.jsword.passage.AbstractKeyList |
---|
clone, compareTo, getName, getName, getOsisID, getOsisRef, retain, retainAll, setName, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.crosswire.jsword.passage.Key |
---|
clone, getName, getName, getOsisID, getOsisRef, retainAll |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Field Detail |
---|
private Key parent
private List list
private static final Logger log
Constructor Detail |
---|
public SetKeyList(Set set)
public SetKeyList(Set set, String name)
public SetKeyList(Set set, Key parent)
public SetKeyList(Set set, Key parent, String name)
Method Detail |
---|
public void addAll(Key key)
Key
addAll
in interface Key
key
- element to be added to this set.public void clear()
Key
clear
in interface Key
public boolean contains(Key key)
Key
contains
in interface Key
contains
in class AbstractKeyList
key
- element whose presence in this set is to be tested.
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
public boolean isEmpty()
Key
isEmpty
in interface Key
isEmpty
in class AbstractKeyList
public Iterator iterator()
iterator
in interface Iterable
public void removeAll(Key key)
Key
removeAll
in interface Key
key
- object to be removed from this set, if present.public int getChildCount()
Key
getChildCount
in interface Key
public boolean canHaveChildren()
Key
canHaveChildren
in interface Key
public Key get(int index)
Key
get
in interface Key
index
- The index of the Key to retrieve
public int indexOf(Key that)
Key
indexOf
in interface Key
that
- The Key to find
public Key getParent()
Key
getParent
in interface Key
public void blur(int by, RestrictionType restrict)
Key
blur
in interface Key
by
- The number of verses/keys to widen byrestrict
- How should we restrict the blurring?Passage
|
Copyright ? 2003-2006 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |