ChapterPassage class final

A passage covering one chapter or an inclusive range of chapters.

Inheritance
Available extensions

Constructors

ChapterPassage(BibleBookEnum book, int startChapter, [int? endChapter])
factory
ChapterPassage.checked({required BibleBookEnum book, required int startChapter, int? endChapter})
Creates a chapter passage while enforcing numeric and ordering checks.
factory

Properties

book → BibleBookEnum
final
displayString → String
A compact, canonical representation of this passage.
no setteroverride
endChapter → int?
final
hashCode → int
The hash code for this object.
no setteroverride
osisIdentifier → String

Available on Passage, provided by the PassageMachineIdentifiers extension

Encodes this passage using OSIS book and coordinate identifiers.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startChapter → int
final
usfmIdentifier → String

Available on Passage, provided by the PassageMachineIdentifiers extension

Encodes this passage using USFM book and coordinate identifiers.
no setter

Methods

format({BibleLanguageEnum language = BibleLanguageEnum.english, ReferenceBookNameStyle bookNameStyle = ReferenceBookNameStyle.long, bool compactRanges = true}) → String

Available on Passage, provided by the LocalizedPassageFormatting extension

Formats this passage with localized long or short book names.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object?>
Converts this passage to a stable JSON-compatible map.
override
toString() → String
A string representation of this object.
inherited

Operators

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

Static Methods

fromJson(Map<String, Object?> json) → ChapterPassage
Restores a passage produced by toJson.
override