|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.passage.VerseRangeFactory
public final class VerseRangeFactory
A factory that creates VerseRanges from user input.
for license details.
The copyright to this program is held by it's authors.
Constructor Summary | |
---|---|
private |
VerseRangeFactory()
prevent instantiation |
Method Summary | |
---|---|
static VerseRange |
fromString(String orginal)
Deprecated. use fromString(Versification, String) instead |
static VerseRange |
fromString(String original,
VerseRange basis)
Deprecated. use fromString(Versification, String, VerseRange) instead |
static VerseRange |
fromString(Versification v11n,
String orginal)
Construct a VerseRange from a human readable string. |
static VerseRange |
fromString(Versification v11n,
String original,
VerseRange basis)
Construct a VerseRange from a String and a VerseRange. |
private static VerseRange |
fromText(Versification v11n,
String original,
String startVerseDesc,
String endVerseDesc,
VerseRange basis)
The internal mechanism by which we construct a VerseRange |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
private VerseRangeFactory()
Method Detail |
---|
@Deprecated public static VerseRange fromString(String orginal) throws NoSuchVerseException
fromString(Versification, String)
instead
orginal
- The textual representation
NoSuchVerseException
- If the text can not be understoodpublic static VerseRange fromString(Versification v11n, String orginal) throws NoSuchVerseException
v11n
- The versification for this VerseRangeorginal
- The textual representation
NoSuchVerseException
- If the text can not be understood@Deprecated public static VerseRange fromString(String original, VerseRange basis) throws NoSuchVerseException
fromString(Versification, String, VerseRange)
instead
This constructor is different from the (String, Verse) constructor in that if the basis is a range that exactly covers a chapter and the string is a single number, then we assume that the number refers to a chapter and not to a verse. This allows us to have a Passage like "Gen 1,2" and have the 2 understood as chapter 2 and not verse 2 of Gen 1, which would have occurred otherwise.
original
- The string describing the verse e.g "2:2"basis
- The verse that forms the basis by which to understand the
original.
NoSuchVerseException
- If the reference is illegalpublic static VerseRange fromString(Versification v11n, String original, VerseRange basis) throws NoSuchVerseException
This constructor is different from the (String, Verse) constructor in that if the basis is a range that exactly covers a chapter and the string is a single number, then we assume that the number refers to a chapter and not to a verse. This allows us to have a Passage like "Gen 1,2" and have the 2 understood as chapter 2 and not verse 2 of Gen 1, which would have occurred otherwise.
v11n
- The versification for this VerseRangeoriginal
- The string describing the verse e.g "2:2"basis
- The verse that forms the basis by which to understand the
original.
NoSuchVerseException
- If the reference is illegalprivate static VerseRange fromText(Versification v11n, String original, String startVerseDesc, String endVerseDesc, VerseRange basis) throws NoSuchVerseException
v11n
- The versification for this VerseRangeoriginal
- The string describing the verse e.g "2:2"startVerseDesc
- The part of the range before the range separatorendVerseDesc
- The part of the range after the range separatorbasis
- The verse that forms the basis by which to understand the
original.
NoSuchVerseException
- If the reference is illegal
|
Copyright ? 2003-2011 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |