Reference class

A general BibleReference, can contain all ReferenceTypes.

Reference objects are general references that can refer to either a single verse, a range of verses, a single chapter, or entire an entire book. This is the returned type when using parseReference and parseAllReferences.

Inheritance

Constructors

Reference(String book, [int? schp, int? svn, int? echp, int? evn])
The universal constructor, determines what kind of reference this is based on which fields are left null.
Reference.chapter(String book, int chapter)
Construct a Reference as a chapter.
Reference.chapterRange(String book, int startChapter, int endChapter)
Construct a Reference as a chapter range such as Genesis 2-3.
Reference.verse(String book, int chapter, int verse)
Construct a Reference as a verse.
Reference.verseRange(String book, int chapter, int startVerse, int endVerse)
Construct a Reference as a verse range such as Genesis 2:3-4.

Properties

abbrBook → String?
The uppercased paratext abbreviation for this reference's book.
no setterinherited
abbrReference → String?
The uppercased paratext abbreviation for this reference.
no setteroverride
book → String
The full book name of the reference.
finalinherited
bookNumber → int?
The book number for the passed in reference book.
finalinherited
chapters → List<Chapter>?
Creates a list containing every chapter found within this reference.
no setter
endChapter → Chapter?
The last Chapter object within this reference.
final
endChapterNumber → int?
The number for the last chapter in this reference.
final
endVerse → Verse?
The Verse object representing the last verse in this reference.
final
endVerseNumber → int?
The last verse number found in this reference.
final
hashCode → int
The hash code for this object.
no setterinherited
isValid → bool
Whether this reference is within the bible.
final
osisBook → String?
The title cased representation for this reference's book.
no setterinherited
osisReference → String?
The title cased representation for this reference.
no setteroverride
reference → String?
The representation of the reference.
final
referenceType → ReferenceType?
The type of reference this is.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shortBook → String?
The shortest standard abbreviation for this reference's book.
no setterinherited
shortReference → String?
The shortest standard abbreviation for this reference.
no setteroverride
startChapter → Chapter
The first Chapter object within this reference.
final
startChapterNumber → int
The beginning chapter number in this reference.
final
startVerse → Verse
The Verse object representing the first verse in this reference.
final
startVerseNumber → int
The first verse number found in this reference.
final
verses → List<Verse>?
Creates a list containing every verse found within this reference.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
Returns BibleReference.reference
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited