Document class abstract Document

A Couchbase Lite document.

The Document is immutable.

Implemented types
Implementers
Available Extensions

Constructors

Document()

Properties

first → String
The first element.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
The document’s id.
no setter
isEmpty → bool
Whether this collection has no elements.
no setterinherited
isNotEmpty → bool
Whether this collection has at least one element.
no setterinherited
iterator → Iterator<String>
A new Iterator that allows iterating the elements of this Iterable.
no setterinherited
keys → List<String>
The keys of the entries in this dictionary.
no setterinherited
last → String
The last element.
no setterinherited
length → int
The number of entries in this dictionary.
no setterinherited
revisionId → String?
The id representing the document’s revision.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sequence → int
Sequence number of the document in the database.
no setter
single → String
Checks that this iterable has only one element, and returns that element.
no setterinherited

Methods

any(bool test(String element)) → bool
Checks whether any element of this iterable satisfies test.
inherited
array(String key) → Array?
Returns the value for the given key as an Array.
inherited
blob(String key) → Blob?
Returns the value for the given key as a Blob.
inherited
boolean(String key) → bool
Returns the value for the given key as a bool.
inherited
cast<R>() → Iterable<R>
A view of this iterable as an iterable of R instances.
inherited
contains(Object? element) → bool
Whether the collection contains an element equal to element.
inherited
date(String key) → DateTime?
Returns the value for the given key as a DateTime.
inherited
dictionary(String key) → Dictionary?
Returns the value for the given key as a Dictionary.
inherited
elementAt(int index) → String
Returns the indexth element.
inherited
every(bool test(String element)) → bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(String element)) → Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(String element), {String orElse()?}) → String
The first element that satisfies the given predicate test.
inherited
float(String key) → double
Returns the value for the given key as a floating point number.
inherited
fold<T>(T initialValue, T combine(T previousValue, String element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<String> other) → Iterable<String>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(String element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
integer(String key) → int
Returns the value for the given key as an integer number.
inherited
join([String separator = ""]) → String
Converts each element to a String and concatenates the strings.
inherited
lastWhere(bool test(String element), {String orElse()?}) → String
The last element that satisfies the given predicate test.
inherited
map<T>(T toElement(String e)) → Iterable<T>
The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
number(String key) → num?
Returns the value for the given key as a num.
inherited
reduce(String combine(String value, String element)) → String
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
singleWhere(bool test(String element), {String orElse()?}) → String
The single element that satisfies test.
inherited
skip(int count) → Iterable<String>
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(String value)) → Iterable<String>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
string(String key) → String?
Returns the value for the given key as a String.
inherited
take(int count) → Iterable<String>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(String value)) → Iterable<String>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toJson() → String
Returns this document's properties as JSON.
toList({bool growable = true}) → List<String>
Creates a List containing the elements of this Iterable.
inherited
toMutable() → MutableDocument
Returns a mutable copy of the document.
toPlainMap() → Map<String, Object?>
Deeply converts this dictionary into a representation of plain Dart objects and returns it.
inherited
toSet() → Set<String>
Creates a Set containing the same elements as this iterable.
inherited
toString() → String
A string representation of this object.
inherited
value<T extends Object>(String key) → T?
Returns the value for the given key.
inherited
where(bool test(String element)) → Iterable<String>
Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() → Iterable<T>
Creates a new lazy Iterable with all elements that have type T.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited
operator [](String key) → Fragment
Returns a Fragment for the value at the given key.
inherited