|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.versification.BibleBookList
class BibleBookList
A BibleBookList is an ordered list of one or more BibleBooks. Typically, a BibleBookList is a member of a Versification.
The GNU Lesser General Public License for details.
Field Summary | |
---|---|
private int[] |
bookMap
The bookMap maps from a BibleBook to the position that it has in books . |
protected BibleBook[] |
books
The ordered books in this list |
private static long |
serialVersionUID
Serialization ID |
Constructor Summary | |
---|---|
BibleBookList(BibleBook[] books)
Create an ordered BibleBookList from the input. |
Method Summary | |
---|---|
boolean |
contains(BibleBook book)
Does this Versification contain the BibleBook. |
BibleBook |
getBook(int ordinal)
Get the BibleBook by its position in this Versification. |
int |
getBookCount()
Get the number of books in this Versification. |
BibleBook |
getFirstBook()
Return the first book in the list. |
BibleBook |
getLastBook()
Return the first book in the list. |
BibleBook |
getNextBook(BibleBook book)
Given a BibleBook, get the next BibleBook in this Versification. |
int |
getOrdinal(BibleBook book)
Where does the BibleBook come in the order of books of the Bible. |
BibleBook |
getPreviousBook(BibleBook book)
Given a BibleBook, get the previous BibleBook in this Versification. |
private void |
initialize()
The bookMap contains one slot for every BibleBook, indexed by it's ordinal value. |
Iterator<BibleBook> |
iterator()
Get the BibleBooks in this Versification. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected BibleBook[] books
private int[] bookMap
books
.
private static final long serialVersionUID
Constructor Detail |
---|
public BibleBookList(BibleBook[] books)
books
- Method Detail |
---|
public boolean contains(BibleBook book)
book
-
public int getOrdinal(BibleBook book)
book
-
public int getBookCount()
public BibleBook getBook(int ordinal)
ordinal
-
public Iterator<BibleBook> iterator()
iterator
in interface Iterable<BibleBook>
public BibleBook getFirstBook()
public BibleBook getLastBook()
public BibleBook getPreviousBook(BibleBook book)
book
- A BibleBook in the Versification
public BibleBook getNextBook(BibleBook book)
book
- A BibleBook in the Versification
private void initialize()
|
Copyright ยจ 2003-2015 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |