|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.passage.ReadOnlyKeyList
public class ReadOnlyKeyList
A read-only wrapper around any writable implementation of 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 boolean |
ignore
Do we ignore write requests or throw? |
private Key |
keys
The Key to which we proxy |
Constructor Summary | |
---|---|
ReadOnlyKeyList(Key keys,
boolean ignore)
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). |
int |
compareTo(Object o)
|
boolean |
contains(Key key)
Returns true if this set contains the specified element. |
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). |
String |
getName()
A Human readable version of the Key. |
String |
getOSISName()
The OSIS defined specification for this Passage. |
Key |
getParent()
All keys have parents unless they are the root of a Key. |
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. |
void |
retainAll(Key key)
Removes all but the specified element from this set. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private boolean ignore
private Key keys
Constructor Detail |
---|
public ReadOnlyKeyList(Key keys, boolean ignore)
Method Detail |
---|
public int getChildCount()
Key
getChildCount
in interface Key
public boolean canHaveChildren()
Key
canHaveChildren
in interface Key
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 Iterator iterator()
iterator
in interface Key
public void addAll(Key key)
Key
addAll
in interface Key
key
- element to be added to this set.public void removeAll(Key key)
Key
removeAll
in interface Key
key
- object to be removed from this set, if present.public void retainAll(Key key)
Key
retainAll
in interface Key
key
- object to be left in this set.public void clear()
Key
clear
in interface Key
public String getName()
Key
getName
in interface Key
public String getOSISName()
Key
getOSISName
in interface Key
public int compareTo(Object o)
compareTo
in interface Comparable
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-2004 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |