|
||||||||||
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.
Distribution Licence: JSword is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. The License is available on the internet here, or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA The copyright to this program is held by it's authors. |
Licence
Field Summary | |
---|---|
private String |
name
The common user visible name for this work |
private String |
osisName
The OSIS ID attribute |
Constructor Summary | |
---|---|
AbstractKeyList()
|
Method Summary | |
---|---|
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 |
getOSISName()
The OSIS defined specification for this Passage. |
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 |
---|
clone, 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, iterator, removeAll |
Field Detail |
---|
private String name
private String osisName
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 getOSISName()
Key
getOSISName
in interface Key
public int compareTo(Object obj)
compareTo
in interface Comparable
|
Copyright ? 2003-2004 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |