|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.passage.AbstractKeyList
public abstract class AbstractKeyList
An implementation of some of the easier methods from Key.
for license details.
The copyright to this program is held by it's authors.
,
Serialized FormNested Class Summary | |
---|---|
(package private) static class |
AbstractKeyList.NameVisitor
The NameVisitor constructs a readable representation
of the Passage. |
(package private) static class |
AbstractKeyList.OsisIDVisitor
The OsisRefVisitor constructs a readable representation
of the Passage, using OSIS names. |
(package private) static class |
AbstractKeyList.OsisRefVisitor
The OsisRefVisitor constructs a readable representation
of the Passage, using OSIS names. |
Field Summary | |
---|---|
private String |
name
The common user visible name for this work |
Constructor Summary | |
---|---|
AbstractKeyList()
|
Method Summary | |
---|---|
Object |
clone()
This needs to be declared here so that it is visible as a method on a derived Key. |
int |
compareTo(Object obj)
|
boolean |
contains(Key key)
Returns true if this set contains the specified element. |
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. |
boolean |
isEmpty()
Does this Passage have 0 members |
protected static void |
retain(Key alter,
Key base)
Utility to remove all the keys from alter that are not in base |
void |
retainAll(Key key)
Removes all but the specified element from this set. |
void |
setName(String name)
Override the default name with a custom name. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.crosswire.jsword.passage.Key |
---|
addAll, blur, canHaveChildren, clear, get, getChildCount, getParent, indexOf, removeAll |
Methods inherited from interface org.crosswire.common.util.Iterable |
---|
iterator |
Field Detail |
---|
private String name
Constructor Detail |
---|
public AbstractKeyList()
Method Detail |
---|
public boolean isEmpty()
Key
isEmpty
in interface Key
public boolean contains(Key key)
Key
contains
in interface Key
key
- element whose presence in this set is to be tested.
public void retainAll(Key key)
Key
retainAll
in interface Key
key
- object to be left in this set.protected static void retain(Key alter, Key base)
alter
- The key to remove keys frombase
- The check keypublic String toString()
toString
in class Object
public void setName(String name)
public String getName()
Key
getName
in interface Key
public String getName(Key base)
Key
getName
in interface Key
base
- The key to use to cut down unnecessary output.
public String getOsisRef()
Key
getOsisRef
in interface Key
public String getOsisID()
Key
getOsisID
in interface Key
public int compareTo(Object obj)
compareTo
in interface Comparable
public Object clone()
Key
clone
in interface Key
clone
in class Object
|
Copyright ยจ 2003-2006 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |