references library
Bible reference and passage models, parsing APIs, and parse results.
Classes
- BookPassage
- A passage covering an entire Bible book.
- ChapterPassage
- A passage covering one chapter or an inclusive range of chapters.
-
ParseFailure<
T> - A failed ParseResult.
-
ParseResult<
T> - The result of a non-throwing parse operation.
-
ParseSuccess<
T> - A successful ParseResult.
- Passage
- A complete Bible passage expression.
- PassageParser
- A reusable parser for book, chapter, verse-list, and passage sequences.
- PassageSequence
- A source-ordered sequence of passage expressions.
- Reference
- Base class for all Bible reference types.
- ReferenceBookCandidate
- A single possible interpretation of a parsed book token.
- ReferenceBookTokenMatch
- Match information for one explicit book token in the source text.
- ReferenceParseMetadata
- Metadata captured while a reference is parsed successfully.
- ReferenceParser
- A configurable, reusable Bible-reference parser.
- VerseLabel
- The verse label of one text entry in a Bible translation.
- VersePassage
- One or more discrete verse references belonging to one passage expression.
- VerseRangeRef
- A reference to a range of Bible verses.
- VerseRef
- A reference to a single Bible verse.
Enums
- ReferenceAmbiguityPolicy
- Controls how a ReferenceParser resolves aliases that match several books.
- ReferenceParseErrorCode
- A typed classification for reference parsing failures.
Constants
- maxReferenceChapterNumber → const int
- Broad sanity limits used by reference construction and parsing.
- maxReferenceVerseNumber → const int
Properties
-
autoLanguageCollisions
→ Map<
String, Set< BibleBookEnum> > -
Auto language collisions.
final
-
autoLanguagePrecedence
→ List<
String> -
Auto language precedence.
final
Functions
-
parseReference(
String ref, {BibleLanguageEnum? language}) → Reference - Parse a Bible reference string into either a VerseRef or VerseRangeRef.
-
verseRangeRefFromStr(
String ref, {BibleLanguageEnum? language}) → VerseRangeRef - Parse a string into a VerseRangeRef.
-
verseRefFromStr(
String ref, {BibleLanguageEnum? language}) → VerseRef - Parse a string into a VerseRef.
Exceptions / Errors
- ParseVerseRefError
- Raised when a verse reference string cannot be parsed.