AnyRealmCollection

public final class AnyRealmCollection<T: Object>: RealmCollectionType

A type-erased RealmCollectionType.

Instances of RealmCollectionType forward operations to an opaque underlying collection having the same Element type.

  • Returns the object at the given index.

    Declaration

    Swift

    public subscript(index: Int) -> T { return base[index] }

    Parameters

    index

    The index.

    Return Value

    The object at the given index.

    Show on GitHub

  • The type of the objects contained in the collection.

    Declaration

    Swift

    public typealias Element = T
    Show on GitHub

  • Creates an AnyRealmCollection wrapping base.

    Declaration

    Swift

    public init<C: RealmCollectionType where C.Element == T>(_ base: C)
    Show on GitHub

Properties

  • The Realm which manages this collection, or nil if the collection is unmanaged.

    Declaration

    Swift

    public var realm: Realm? { return base.realm }
    Show on GitHub

  • Indicates if the collection can no longer be accessed.

    The collection can no longer be accessed if invalidate is called on the containing realm.

    Declaration

    Swift

    public var invalidated: Bool { return base.invalidated }
    Show on GitHub

  • The number of objects in the collection.

    Declaration

    Swift

    public var count: Int { return base.count }
    Show on GitHub

  • A human-readable description of the objects contained in the collection.

    Declaration

    Swift

    public var description: String { return base.description }
    Show on GitHub

Index Retrieval

  • Returns the index of an object in the collection.

    Declaration

    Swift

    public func indexOf(object: Element) -> Int? { return base.indexOf(object) }

    Parameters

    object

    An object.

    Return Value

    The index of the given object, or nil if the object is not in the collection.

    Show on GitHub

  • Returns the index of the first object matching the predicate.

    Declaration

    Swift

    public func indexOf(predicate: NSPredicate) -> Int? { return base.indexOf(predicate) }

    Parameters

    predicate

    The predicate to use to filter the objects.

    Return Value

    The index of the first object that matches, or nil if no objects match.

    Show on GitHub

  • Returns the index of the first object matching the predicate.

    Declaration

    Swift

    public func indexOf(predicateFormat: String, _ args: AnyObject...) -> Int?

    Parameters

    predicateFormat

    A predicate format string, optionally followed by a variable number of arguments.

    Return Value

    The index of the first object that matches, or nil if no objects match.

    Show on GitHub

Filtering

  • Returns all objects matching the given predicate in the collection.

    Declaration

    Swift

    public func filter(predicateFormat: String, _ args: AnyObject...) -> Results<Element>

    Parameters

    predicateFormat

    A predicate format string, optionally followed by a variable number of arguments.

    Return Value

    A Results containing objects that match the given predicate.

    Show on GitHub

  • Returns all objects matching the given predicate in the collection.

    Declaration

    Swift

    public func filter(predicate: NSPredicate) -> Results<Element> { return base.filter(predicate) }

    Parameters

    predicate

    The predicate to use to filter the objects.

    Return Value

    A Results containing objects that match the given predicate.

    Show on GitHub

Sorting

  • Returns a sorted Results from the collection.

    Declaration

    Swift

    public func sorted(property: String, ascending: Bool) -> Results<Element>

    Parameters

    property

    The property name to sort by.
    ascending

    The direction to sort in.

    Return Value

    A Results sorted by the specified property.

    Show on GitHub

  • Returns a sorted Results from the collection.

    Declaration

    Swift

    public func sorted<S: SequenceType where S.Generator.Element == SortDescriptor>
                      (sortDescriptors: S) -> Results<Element>

    Parameters

    sortDescriptors

    A sequence of SortDescriptors to sort by.

    Return Value

    A Results sorted by the specified properties.

    Show on GitHub

Aggregate Operations

  • Returns the minimum (lowest) value of the given property among all the objects represented by the collection.

    Warning

    Only a property whose type conforms to the MinMaxType protocol can be specified.

    Declaration

    Swift

    public func min<U: MinMaxType>(property: String) -> U? { return base.min(property) }

    Parameters

    property

    The name of a property whose minimum value is desired.

    Return Value

    The minimum value of the property, or nil if the collection is empty.

    Show on GitHub

  • Returns the maximum (highest) value of the given property among all the objects represented by the collection.

    Warning

    Only a property whose type conforms to the MinMaxType protocol can be specified.

    Declaration

    Swift

    public func max<U: MinMaxType>(property: String) -> U? { return base.max(property) }

    Parameters

    property

    The name of a property whose minimum value is desired.

    Return Value

    The maximum value of the property, or nil if the collection is empty.

    Show on GitHub

  • Returns the sum of the values of a given property over all the objects represented by the collection.

    Warning

    Only a property whose type conforms to the AddableType protocol can be specified.

    Declaration

    Swift

    public func sum<U: AddableType>(property: String) -> U { return base.sum(property) }

    Parameters

    property

    The name of a property whose values should be summed.

    Return Value

    The sum of the given property.

    Show on GitHub

  • Returns the average value of a given property over all the objects represented by the collection.

    Warning

    Only the name of a property whose type conforms to the AddableType protocol can be specified.

    Declaration

    Swift

    public func average<U: AddableType>(property: String) -> U? { return base.average(property) }

    Parameters

    property

    The name of a property whose average value should be calculated.

    Return Value

    The average value of the given property, or nil if the collection is empty.

    Show on GitHub

Sequence Support

  • Returns a GeneratorOf<T> that yields successive elements in the collection.

    Declaration

    Swift

    public func generate() -> RLMGenerator<T> { return base.generate() }
    Show on GitHub

Collection Support

  • The position of the first element in a non-empty collection. Identical to endIndex in an empty collection.

    Declaration

    Swift

    public var startIndex: Int { return base.startIndex }
    Show on GitHub

  • The collection’s past the end position. endIndex is not a valid argument to subscript, and is always reachable from startIndex by zero or more applications of successor().

    Declaration

    Swift

    public var endIndex: Int { return base.endIndex }
    Show on GitHub

Key-Value Coding

  • Returns an Array containing the results of invoking valueForKey(_:) with key on each of the collection’s objects.

    Declaration

    Swift

    public func valueForKey(key: String) -> AnyObject? { return base.valueForKey(key) }

    Parameters

    key

    The name of the property.

    Return Value

    An Array containing the results.

    Show on GitHub

  • Returns an Array containing the results of invoking valueForKeyPath(_:) with keyPath on each of the collection’s objects.

    Declaration

    Swift

    public func valueForKeyPath(keyPath: String) -> AnyObject? { return base.valueForKeyPath(keyPath) }

    Parameters

    keyPath

    The key path to the property.

    Return Value

    An Array containing the results.

    Show on GitHub

  • Invokes setValue(_:forKey:) on each of the collection’s objects using the specified value and key.

    Warning

    This method may only be called during a write transaction.

    Declaration

    Swift

    public func setValue(value: AnyObject?, forKey key: String) { base.setValue(value, forKey: key) }

    Parameters

    value

    The object value.
    key

    The name of the property.
    Show on GitHub

Notifications

  • Registers a block to be called each time the collection changes.

    The block will be asynchronously called with the initial results, and then called again after each write transaction which changes either any of the objects in the collection, or which objects are in the collection.

    The change parameter that is passed to the block reports, in the form of indices within the collection, which of the objects were added, removed, or modified during each write transaction. See the RealmCollectionChange documentation for more information on the change information supplied and an example of how to use it to update a UITableView.

    At the time when the block is called, the collection will be fully evaluated and up-to-date, and as long as you do not perform a write transaction on the same thread or explicitly call realm.refresh(), accessing it will never perform blocking work.

    Notifications are delivered via the standard run loop, and so can’t be delivered while the run loop is blocked by other activity. When notifications can’t be delivered instantly, multiple notifications may be coalesced into a single notification. This can include the notification with the initial collection. For example, the following code performs a write transaction immediately after adding the notification block, so there is no opportunity for the initial notification to be delivered first. As a result, the initial notification will reflect the state of the Realm after the write transaction.

    let results = realm.objects(Dog)
print("dogs.count: \(dogs?.count)") // => 0
let token = dogs.addNotificationBlock { (changes: RealmCollectionChange) in
    switch changes {
        case .Initial(let dogs):
            // Will print "dogs.count: 1"
            print("dogs.count: \(dogs.count)")
            break
        case .Update:
            // Will not be hit in this example
            break
        case .Error:
            break
    }
}
try! realm.write {
    let dog = Dog()
    dog.name = "Rex"
    person.dogs.append(dog)
}
// end of run loop execution context

    You must retain the returned token for as long as you want updates to continue to be sent to the block. To stop receiving updates, call stop() on the token.

    Warning

    This method cannot be called during a write transaction, or when the containing Realm is read-only.

    Declaration

    Swift

    public func addNotificationBlock(block: (RealmCollectionChange<AnyRealmCollection>) -> ())
        -> NotificationToken { return base._addNotificationBlock(block) }

    Parameters

    block

    The block to be called whenever a change occurs.

    Return Value

    A token which must be retained for as long as you want updates to be delivered.

    Show on GitHub