org.crosswire.jsword.passage
Class VerseFactory

java.lang.Object
  org.crosswire.jsword.passage.VerseFactory

public final class VerseFactory
extends Object

A factory to create a Verse from user input.

Author:

Joe Walker [joe at eireneh dot com]

See Also:

for license details.
The copyright to this program is held by it's authors.

Constructor Summary

private

VerseFactory() Prevent a VerseFactory from being created.

Method Summary

static Verse	fromString(String original) Deprecated. use fromString(Versification, String) instead
static Verse	fromString(String original, VerseRange verseRangeBasis) Deprecated. use fromString(Versification, String, VerseRange) instead
static Verse	fromString(Versification v11n, String original)
static Verse	fromString(Versification v11n, String original, VerseRange verseRangeBasis)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VerseFactory

private VerseFactory()

Prevent a VerseFactory from being created.

Method Detail

fromString

@Deprecated
public static Verse fromString(String original)
                        throws NoSuchVerseException

Deprecated. use fromString(Versification, String) instead

Construct a Verse from a String - something like "Gen 1:1". in case the user does not want to have their typing 'fixed' by a meddling patronizing computer. The following initial letters can not be matched at all - 'bfquvwx'.

Parameters:

original - The text string to be converted

Returns:

the Verse representation of the string

Throws:

NoSuchVerseException - If the text can not be understood

fromString

public static Verse fromString(Versification v11n,
                               String original)
                        throws NoSuchVerseException

Throws:

NoSuchVerseException

fromString

@Deprecated
public static Verse fromString(String original,
                                          VerseRange verseRangeBasis)
                        throws NoSuchVerseException

Deprecated. use fromString(Versification, String, VerseRange) instead

Construct a Verse from a String and a VerseRange. For example given "2:2" and a basis of Gen 1:1 - 12 the result would be Gen 2:2

Parameters:

original - The string describing the verse e.g "2:2"

verseRangeBasis - The basis by which to understand the desc.

Returns:

the verse representation of the string

Throws:

NoSuchVerseException - If the reference is illegal

fromString

public static Verse fromString(Versification v11n,
                               String original,
                               VerseRange verseRangeBasis)
                        throws NoSuchVerseException

Throws:

NoSuchVerseException