ReferenceParser class final
A configurable, reusable Bible-reference parser.
Custom aliases are language-neutral and intentionally outrank bundled aliases. aliasesByLanguage adds localized aliases that are considered only in auto mode or when that language is explicitly selected.
Constructors
-
ReferenceParser({Map<
String, BibleBookEnum> aliases = const {}, Map<BibleLanguageEnum, Map< aliasesByLanguage = const {}, Iterable<String, BibleBookEnum> >BibleLanguageEnum> preferredLanguages = const [], ReferenceAmbiguityPolicy ambiguityPolicy = ReferenceAmbiguityPolicy.preferLanguagePriority}) -
factory
Properties
-
aliases
→ Map<
String, BibleBookEnum> -
Language-neutral aliases that override bundled aliases.
final
-
aliasesByLanguage
→ Map<
BibleLanguageEnum, Map< String, BibleBookEnum> > -
Caller-provided aliases scoped to a concrete language.
final
- ambiguityPolicy → ReferenceAmbiguityPolicy
-
The configured collision policy.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
preferredLanguages
→ List<
BibleLanguageEnum> -
Languages moved ahead of the default auto-detection order.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
parse(
String ref, {BibleLanguageEnum? language}) → Reference -
parseRange(
String ref, {BibleLanguageEnum? language}) → VerseRangeRef -
parseRangeResult(
String ref, {BibleLanguageEnum? language}) → ParseResult< VerseRangeRef> -
parseResult(
String ref, {BibleLanguageEnum? language}) → ParseResult< Reference> -
parseVerse(
String ref, {BibleLanguageEnum? language}) → VerseRef -
parseVerseResult(
String ref, {BibleLanguageEnum? language}) → ParseResult< VerseRef> -
toString(
) → String -
A string representation of this object.
inherited
-
tryParse(
String ref, {BibleLanguageEnum? language}) → Reference? -
tryParseRange(
String ref, {BibleLanguageEnum? language}) → VerseRangeRef? -
tryParseVerse(
String ref, {BibleLanguageEnum? language}) → VerseRef?
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- standard → ReferenceParser
-
Shared parser used by static parsing APIs.
final