MutableSet

public final class MutableSet<Element> : RLMSwiftCollectionBase where Element : RealmCollectionValue
extension MutableSet: ObservableObject, RealmSubscribable
extension MutableSet: RealmCollection
extension MutableSet: Decodable where Element: Decodable
extension MutableSet: Encodable where Element: Encodable

MutableSet は、オブジェクトとして個別の値を持つ対多の関係を定義するために使用される Realm のコンテナ タイプです。

Swift のSetと同様に、 MutableSetは、保存する型をパラメータ化するジェネリック型です。 これは、 Objectサブクラスまたは次のいずれかのタイプになります。 BoolIntInt8Int16Int32Int64FloatDoubleStringDataDateDecimal128ObjectId (およびこれらの任意バージョン)

Swift のネイティブ コレクションとは異なり、 MutableSetは参照型であり、それを管理する Realm が読み取り専用として開かれている場合にのみ不変です。

MutableSet の は、 Results<Element>と同じ述語でフィルタリングおよびソートできます。

Objectサブクラスで定義されているMutableSet型のプロパティは、 letとして宣言する必要があります。また、 dynamicにすることはできません。

プロパティ

  • セットを管理する Realm、またはセットが管理されていない場合はnil

    宣言

    Swift

    public var realm: Realm? { get }
  • セットがアクセスできなくなっているかどうかを示します。

    宣言

    Swift

    public var isInvalidated: Bool { get }

初期化子

  • タイプElementの Realm モデル オブジェクトを保持するMutableSetを作成します。

    宣言

    Swift

    public override init()

  • この MutableSet 内のオブジェクトの数を返します。

    宣言

    Swift

    public var count: Int { get }

KVM

  • コレクションの各オブジェクトでkeyを使用してvalueForKey(_:)を呼び出した結果を含むArrayを返します。

    宣言

    Swift

    @nonobjc
    public func value(forKey key: String) -> [AnyObject]
  • コレクションの各オブジェクトでkeyPathを使用してvalueForKeyPath(_:)を呼び出した結果を含むArrayを返します。

    宣言

    Swift

    @nonobjc
    public func value(forKeyPath keyPath: String) -> [AnyObject]

    パラメーター

    keyPath

    値が必要なプロパティへのキー パス。

  • 指定されたvaluekeyを使用して、コレクション内の各オブジェクトでsetValue(_:forKey:)を呼び出します。

    警告

    このメソッドは、書込みトランザクション中にのみ呼び出すことができます。

    宣言

    Swift

    public override func setValue(_ value: Any?, forKey key: String)

    パラメーター

    value

    オブジェクト値。

    key

    各オブジェクトに値を設定するプロパティの名前。

フィルタリング

  • セット内の指定された述語に一致するすべてのオブジェクトを含むResultsを返します。

    宣言

    Swift

    public func filter(_ predicate: NSPredicate) -> Results<Element>

    パラメーター

    predicate

    オブジェクトをフィルタリングする述語。

  • セットに指定されたオブジェクトが含まれているかどうかを示すブール値を返します。

    宣言

    Swift

    public func contains(_ object: Element) -> Bool

    パラメーター

    object

    MutableSet で検索する要素。

  • このセットが指定されたセットのサブセットであるかどうかを示すブール値を返します。

    宣言

    Swift

    public func isSubset(of possibleSuperset: MutableSet<Element>) -> Bool

    パラメーター

    object

    比較する別の MutableSet。

  • このセットが別の指定されたセットと交差するかどうかを示すブール値を返します。

    宣言

    Swift

    public func intersects(_ otherSet: MutableSet<Element>) -> Bool

    パラメーター

    object

    比較する別の MutableSet。

ソート

  • セット内のオブジェクトを含むResultsをソートされた状態で返します。

    オブジェクトは、指定されたキー パスの値に基づいてソートされます。 たとえば、 Studentのセットをageプロパティに基づいて、小さいものから古い順に並べ替えるには、 students.sorted(byKeyPath: "age", ascending: true)を呼び出します。

    警告

    MutableSets は、ブール値、 DateNSDate 、単一および倍精度浮動小数点、整数、および string 型のプロパティによってのみソートできます。

    宣言

    Swift

    public func sorted(byKeyPath keyPath: String, ascending: Bool = true) -> Results<Element>

    パラメーター

    keyPath

    ソートするキー パス。

    ascending

    並べ替える方向。

  • セット内のオブジェクトを含むResultsをソートされた状態で返します。

    警告

    MutableSets は、ブール値、 DateNSDate 、単一および倍精度浮動小数点、整数、および string 型のプロパティによってのみソートできます。

    詳細は、次を参照してください:

    sorted(byKeyPath:ascending:)

    宣言

    Swift

    public func sorted<S: Sequence>(by sortDescriptors: S) -> Results<Element>
        where S.Iterator.Element == SortDescriptor

集計操作

  • セット内のすべてのオブジェクト間で指定されたプロパティの最小(最小)値を返します。セットが空の場合はnilを返します。

    警告

    MinMaxTypeプロトコルに準拠するタイプのプロパティのみを指定できます。

    宣言

    Swift

    public func min<T>(ofProperty property: String) -> T? where T : MinMaxType

    パラメーター

    property

    最小値が必要なプロパティの名前。

  • セット内のすべてのオブジェクト間で指定されたプロパティの最大値(最高値)を返します。セットが空の場合はnilを返します。

    警告

    MinMaxTypeプロトコルに準拠するタイプのプロパティのみを指定できます。

    宣言

    Swift

    public func max<T>(ofProperty property: String) -> T? where T : MinMaxType

    パラメーター

    property

    最大値が必要なプロパティの名前。

  • セット内のすべてのオブジェクトの指定されたプロパティの値の合計を返します。

    警告

    AddableTypeプロトコルに準拠するタイプのプロパティのみを指定できます。

    宣言

    Swift

    public func sum<T>(ofProperty property: String) -> T where T : AddableType

    パラメーター

    property

    値を合計するプロパティの名前。

  • セット内のすべてのオブジェクトにわたる指定されたプロパティの平均値を返します。セットが空の場合はnilを返します。

    警告

    AddableTypeプロトコルに準拠するタイプのプロパティのみを指定できます。

    宣言

    Swift

    public func average<T>(ofProperty property: String) -> T? where T : AddableType

    パラメーター

    property

    平均値を計算するプロパティの名前。

ミューテーション

  • オブジェクトがまだ存在しない場合は、セットに挿入します。

    警告

    このメソッドは、書込みトランザクション中にのみ呼び出されます。

    宣言

    Swift

    public func insert(_ object: Element)

    パラメーター

    object

    オブジェクト。

  • 指定されたシーケンスをオブジェクトがまだ存在しない場合は、セットに挿入します。

    警告

    このメソッドは、書込みトランザクション中にのみ呼び出されます。

    宣言

    Swift

    public func insert<S>(objectsIn objects: S) where Element == S.Element, S : Sequence
  • セット内のオブジェクトが存在する場合は、それを削除します。 オブジェクトは、それを管理する Realm から削除されません。

    警告

    このメソッドは、書込みトランザクション中にのみ呼び出されます。

    宣言

    Swift

    public func remove(_ object: Element)

    パラメーター

    object

    削除するオブジェクト。

  • セットからすべてのオブジェクトを削除します。 オブジェクトは、それらを管理する Realm から削除されません。

    警告

    このメソッドは、書込みトランザクション中にのみ呼び出されます。

    宣言

    Swift

    public func removeAll()
  • このセットと指定されたシーケンスの両方に共通の要素でセットをその場でミューテーションします。

    警告

    このメソッドは、書込みトランザクション中にのみ呼び出されます。

    宣言

    Swift

    public func formIntersection(_ other: MutableSet<Element>)

    パラメーター

    other

    別のセット。

  • セットをその場でミューテーションし、指定されたセットの要素をこのセットから削除します。

    警告

    このメソッドは、書込みトランザクション中にのみ呼び出されます。

    宣言

    Swift

    public func subtract(_ other: MutableSet<Element>)

    パラメーター

    other

    別のセット。

  • 指定されたシーケンスの要素をセットに挿入します。

    警告

    このメソッドは、書込みトランザクション中にのみ呼び出されます。

    宣言

    Swift

    public func formUnion(_ other: MutableSet<Element>)

    パラメーター

    other

    別のセット。

notifications

  • コレクションが変更されるたびに呼び出されるブロックを登録します。

    ブロックは初期結果とは非同期に呼び出され、コレクション内のいずれかのオブジェクトまたはコレクション内のどのオブジェクトのいずれかを変更する書込みトランザクションごとに再度呼び出されます。

    ブロックに渡されるchangeパラメータは、各書込みトランザクション中に追加、削除、または変更されたオブジェクトをコレクション内のインデックスの形式で報告します。 提供される変更情報の詳細と、その変更情報を使用してUITableViewをアップデートする方法の例については、 RealmCollectionChangeのドキュメントを参照してください。

    ブロックが呼び出される時点で、コレクションは完全に評価され、最新の状態になります。また、同じスレッドで書込みトランザクションを実行したり、 realm.refresh()を明示的に呼び出したりしない限り、アクセスに関するブロッキングは実行されません動作する。

    キューが指定されていない場合、通知は標準の実行ループを介して配信されるため、実行ループが他のアクティビティによってブロックされている間は通知を配信できません。 キューが指定されている場合、代わりにそのキューに通知が配信されます。 通知をすぐに配信できない場合は、複数の通知が 1 つの通知に統合されることがあります。 これには、初期コレクションの通知を含めることができます。

    たとえば、次のコードは通知ブロックを追加した後すぐに書込みトランザクションを実行するため、最初の通知が最初に配信される可能性はありません。 その結果、最初の通知には、書込みトランザクション後の Realm の状態が反映されます。

    let results = realm.objects(Dog.self)
    print("dogs.count: \(dogs?.count)") // => 0
    let token = dogs.observe { changes 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.insert(dog)
    }
    // end of run loop execution context
    

    アップデートをブロックに送信する場合は、返されたトークンを保持する必要があります。 更新の受信を停止するには、トークンでinvalidate()を呼び出します。

    警告

    このメソッドは、書込みトランザクション中、または Realm を含む が読み取り専用の場合に呼び出すことができません。

    宣言

    Swift

    public func observe(on queue: DispatchQueue? = nil,
                        _ block: @escaping (RealmCollectionChange<MutableSet>) -> Void) -> NotificationToken

    パラメーター

    queue

    通知を受信するシリアル ディスパッチ キュー。 nilの場合、通知は現在のスレッドに配信されます。

    block

    変更が発生するたびに呼び出されるブロック。

    戻り値

    更新を配信する限り保持する必要があるトークン。

凍結されたオブジェクト

MutableSet

  • コレクションが変更されるたびに Vid を発行する出版社。

    名前に関係なく、コレクションが変更されたにこれが実際に発行します。

    宣言

    Swift

    public var objectWillChange: RealmPublishers.WillChange<MutableSet> { get }
  • セット内に保存されているオブジェクトのタイプ。

    宣言

    Swift

    public typealias ElementType = Element

シーケンス サポート

  • MutableSetで連続する要素を生成するRLMIteratorを返します。

    宣言

    Swift

    public func makeIterator() -> RLMIterator<Element>
  • 空でないコレクション内の最初の要素の位置。 空のコレクション内の endIndex と同じ。

    宣言

    Swift

    public var startIndex: Int { get }
  • コレクションの「終了を過ぎた」位置。 endIndex はサブスクリプトへの有効な引数ではなく、成功します()の 0 個以上のアプリケーションによって startIndex から常にアクセス可能です。

    宣言

    Swift

    public var endIndex: Int { get }
  • 宣言

    Swift

    public func index(after i: Int) -> Int
  • 宣言

    Swift

    public func index(before i: Int) -> Int

オブジェクト検索

  • 警告

    MutableSet では順序は保証されません。 サブスクリプションが便宜上実装されているのは、依存しないでください。

    宣言

    Swift

    public subscript(position: Int) -> Element { get }
  • 警告

    MutableSet では順序は保証されません。 便宜上実装されているfirstは、依存しないでください。

    宣言

    Swift

    public var first: Element? { get }

Element : MinMaxTypeで利用可能

  • セット内の最小(最小)値を返します。セットが空の場合はnilを返します。

    宣言

    Swift

    public func min() -> Element?
  • セット内の最大(最高)値を返します。セットが空の場合はnilを返します。

    宣言

    Swift

    public func max() -> Element?

Element : AddableTypeで利用可能

  • セット内の 値の合計を返します。

    宣言

    Swift

    public func sum() -> Element
  • セット内の値の平均を返します。または、セットが空の場合はnilを返します。

    宣言

    Swift

    public func average<T>() -> T? where T : AddableType

Element : Decodableで利用可能

Element : Encodableで利用可能