XCode 7.3 日本語化計画: CAC: API

+ arrayWithArray:

他の与えられた配列に含まれるオブジェクトを含む配列を作成し、返します。

宣言

<< OBJECTIVE-C >>

+ (instancetype)arrayWithArray:(NSArray<ObjectType> *)anArray

パラメータ

anArray

配列。

戻り値

anArray 内のオブジェクトを含む配列。

利用可能

OS X v10.0 以降で利用可能

以下も見よ

– writeToFile:atomically:

– initWithObjects:

+ arrayWithContentsOfFile:

与えられたパスで指定されたファイルの内容を含む配列を作成し、返します。

<< OBJECTIVE-C >>

+ (NSArray<ObjectType>)arrayWithContentsOfFile:(NSString *)aPath

パラメータ

aPath

writeToFile:atomically: メソッドで生成される配列の文字列表現を含むファイルへのパス。

戻り値

aPath で指定されたファイルの内容を含む配列。ファイルの内容が配列に解析できない場合や、ファイルを開けない場合、nil を返します。

議論

aPath で識別されるファイル内の配列表現は、プロパティリストオブジェクト(NSString、NSData、NSDate、NSNumber、NSArray、または NSDictionary オブジェクト) だけが含まれていなければなりません。詳細については、プロパティリストプログラミングガイド を参照してください。この配列に含まれるオブジェクトは、配列が可変であっても、不変です。

利用可能

OS X v10.0 以降で利用可能

以下も見よ

+ arrayWithContentsOfURL:

与えられた URL で指定された内容を含む配列を作成し、返します。

宣言

<< OBJECTIVE-C >>

+ (NSArray<ObjectType> *)arrayWithContentsOfURL:(NSURL *)aURL

パラメータ

aURL

writeToURL:atomically: メソッドによって生成される配列の文字列表現を含むファイルの場所。

戻り値

aURL で指定した内容を含む配列。場所の内容が配列に解析できない場合や場所を開くことができない場合、nil を返します。

議論

aURL で識別される場所の配列表現は、プロパティリストオブジェクト(NSString、NSData、NSArray、または NSDictionary オブジェクト)だけが含まれていなければなりません。この配列に含まれるオブジェクトは、配列が可変であっても、不変です。

利用可能

OS X v10.0 以降で利用可能

以下も見よ

- writeToURL:atomically:

+ arrayWithObject:

与えられたオブジェクトを含む配列を作成し、返します。

宣言

<< SWIFT >>

convenience init(object anObject: AnyObject)

<< OBJECTIVE-C >>

+ (instancetype)arrayWithObject:(ObjectType)anObject

パラメータ

anObject

オブジェクト。

戻り値

単一の要素 anObject を含む配列。

議論

あるいは、与えられたオブジェクトを含む配列を作成するための Objective-C と Swift での配列リテラル構文を使用できます。

<< OBJECTIVE-C >>

NSArray *array = @[@"Hello, world!"];

<< SWIFT >>

let array: NSArray = ["Hello, world!"]

利用可能

OS X v10.0 以降で利用可能

以下も見よ

+ array

+ arrayWithContentsOfFile:

引数リスト内のオブジェクトを含む配列を作成し、返します。

宣言

+ (instancetype)arrayWithObjects:(ObjectType)firstObj,

, ...

パラメータ

firstObj,
...

nil で終わるオブジェクトの、カンマ区切りのリスト。

戻り値

引数リスト内のオブジェクトを含む配列。

議論

以下のコードの例は、要素の異なる 3 つのタイプを含む配列を作成します。

<< OBJECTIVE-C >>

NSDate *aDate = [NSDate distantFuture];
NSValue *aValue = @(5);
NSString *aString = @"hello";
NSArray *array = [NSArray arrayWithObjects:aDate, aValue, aString, nil];

<< SWIFT >>

let aDate = NSDate.distantFuture()
let aValue = 5
let aString = "hello"
let array = NSArray(objects: aDate, aValue, aString)

あるいは、与えられたオブジェクトを含む配列を作成するための Objective-C と Swift で配列リテラル構文を使用できます。

<< OBJECTIVE-C >>

NSArray *array = @[@"alpha", @"bravo", @"charlie"];

<< SWIFT >>

let array: NSArray = ["alpha", "bravo", "charlie"]

利用可能

OS X v10.0 以降で利用可能

以下も見よ

+ array

+ arrayWithObject:

+ arrayWithObjects:count:

与えられた C 言語の配列から、与えられた数のオブジェクトを含む配列を作成し、返します。

宣言

<< OBJECTIVE-C >>

+ (instancetype)arrayWithObjects:(const ObjectType _Nonnull[])objects
		 count:(NSUInteger)count

パラメータ

objects	オブジェクトの C 言語の配列。
count	新しい配列に含まれる、objects の C 言語配列からの値の数。この数は新しい配列数のカウントであり、それは負の値または objects の要素の数より大きくてはいけません。

戻り値

objects からの最初の count オブジェクトを含む新しい配列。

議論

要素は、objects に現れるのと同じ順序で新しい配列に追加されますが、インデックスの count の数を含めていません。たとえば、次のように：

NSString *strings[3];
strings[0] = @"First";
strings[1] = @"Second";
strings[2] = @"Third";

NSArray *stringsArray = [NSArray arrayWithObjects:strings count:2];
// strings array contains { @"First", @"Second" }

利用可能

OS X 10.0 以降で利用可能

以下も見よ

- getObjects:range:

配列の初期化

- init 指定イニシャライザ

新しく割り当てられた配列を初期化します。

宣言

<< SWIFT >>

init()

<< OBJECTIVE-C >>

- (instancetype)init

戻り値

配列。

議論

immutable 配列は、この方法でで初期化された後は、変更できません。

このメソッドは、指定イニシャライザです。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

- initWithObjects:

- initWithArray:

与えられた配列に含まれるオブジェクトの中に配置することによって、新しく割り当てられた配列を初期化します。

宣言

<< SWIFT >>

convenience init(array array: [AnyObject])

<< OBJECTIVE-C >>

- (instancetype)initWithArray:(NSArray *)anArray

パラメータ

anArray

配列。

戻り値

anArray 内のオブジェクトを含むように初期化される配列。返されるオブジェクトは、元の受信者とは異なる場合があります。

議論

immutable 配列は、この方法で初期化された後は、変更できません。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

+ arrayWithObject:

- initWithObjects:

- initWithArray:copyItems:

配列用のデータ·オブジェクトのソースとして anArray を使用して、新しく割り当てられた配列を初期化します。

宣言

<< SWIFT >>

convenience init(array array: [AnyObject],
       copyItems flag: Bool)

<< OBJECTIVE-C >>

- (instancetype)initWithArray:(NSArray<ObjectType> *)array
                    copyItems:(BOOL)flag

パラメータ

array

どの新しい配列を初期化するべきか、というオブジェクトを含む配列。

flag

YES の場合、オブジェクトのコピーを作成するため、array 内の各オブジェクトは、copyWithZone: メッセージを受け取り、オブジェクトは NSCopying プロトコルに準拠していなければなりません。管理されたメモリ環境では、これは、オブジェクトが他の方法で受け取る、retain メッセージの代わりです。オブジェクトのコピーは、その後、返される配列に追加されます。

NO の場合、管理されたメモリ環境なので、それは返される配列に追加されたときに、array 内の各オブジェクトは、単に retain メッセージを受信します。

戻り値

配列はオブジェクトを含むように初期化され、flag が YES の場合には、array 内のオブジェクトのコピーを返します。返されるオブジェクトは、元の受信者とは異なる場合があります。

議論

immutable 配列は、この方法で初期化された後は、変更できません。

copyWithZone: メソッドは、浅いコピーを実行します。あなたがちょっとした深さのコレクションを持っている場合は、flag パラメータに YES を渡し、表面下の最初のレベルの immutable コピーを実行して下さい。あなたが最初のレベルの mutable 配列に NO を渡した場合には影響を受けません。いずれの場合でも、どの深さのレベルの配列の不変性も影響を受けません。

利用可能

OS X 10.2 以降で利用可能

以下も見よ

- initWithContentsOfFile:

与えられたパスで指定されたファイルの内容で新しく割り当てられた配列を初期化します。

宣言

<< SWIFT >>

convenience init?(contentsOfFile path: String)

<< OBJECTIVE-C >>

- (NSArray<ObjectType> *)initWithContentsOfFile:(NSString *)aPath

パラメータ

aPath

writeToFile:atomically: メソッドで生成された配列の表現を含むファイルへのパス

戻り値

aPath で指定された、ファイルの内容を含む初期化された配列か、またはファイルを開くことができないか、ファイルの内容が配列へと解析できない場合 nil を返します。返されるオブジェクトは、元の受信者とは異なる場合があります。

議論

aPath で識別されるファイル内の配列表現は、プロパティリストオブジェクト(NSString、NSData、NSArray、または NSDictionary オブジェクト) のみを含んでいる必要があります。この配列に含まれるオブジェクトは、配列が可変であっても、不変です。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

- writeToFile:atomically:

- initWithContentsOfURL:

与えられた URL で指定された場所の内容で、新しく割り当てられた配列を初期化します。

宣言

<< SWIFT >>

convenience init?(contentsOfURL url: NSURL)

<< OBJECTIVE-C >>

- (NSArray<ObjectType> *)initWithContentsOfURL:(NSURL *)aURL

パラメータ

aURL

writeToURL:atomically: メソッドによって生成された配列の文字列表現を含むファイルの場所

戻り値

aURL で指定されたコンテンツを含むように初期化された配列。場所が開けない場合や場所の内容が配列に解析できない場合、nil を返します。返されるオブジェクトは、元の受信者とは異なる場合があります。

議論

aURL で識別される場所の配列表現は、プロパティリストオブジェクト(NSString、NSData、NSArray、または NSDictionary オブジェクト) のみを含んでいる必要があります。この配列に含まれるオブジェクトは、配列が可変であっても、不変です。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

+ arrayWithContentsOfURL:

- writeToURL:atomically:

宣言

NSArray.h

- initWithObjects:

引数リスト内の、オブジェクトの中に配置することで、新しく割り当てられた配列を初期化します。

宣言

<< OBJECTIVE-C >>

- (instancetype)initWithObjects:(ObjectType)firstObj

,...

パラメータ

firstObj,
...

nil で終わるオブジェクトのカンマ区切りリスト。

戻り値

引数リスト内のオブジェクトを含むように初期化された配列。返されるオブジェクトは、元の受信者とは異なる場合があります。

議論

不変の配列は、この方法で初期化された後は、変更できません。

このメソッドは、指定イニシャライザです。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

cinit

- initWithObjects:count:

- initWithArray:

- initWithObjects:count: 指定イニシャライザ

与えられた C 言語の配列から、与えられたオブジェクトの数が含まれるように新しく割り当てられた配列を初期化します。

宣言

<< SWIFT >>

init(objects objects: UnsafePointer<AnyObject?>,
       count cnt: Int)

<< OBJECTIVE-C >>

- (instancetype)initWithObjects:(const ObjectType _Nonnull [])objects
                          count:(NSUInteger)count

パラメータ

objects	C 言語型のオブジェクトの配列。
count	新しい配列に含めるべき、objects の C 言語型の配列からの値の数。この数は新しい配列のカウントです - それは負の値または objects の要素数より大きくてはいけません。

戻り値

objects から最初の count のオブジェクトを含む、新しく割り当てられた配列。返されるオブジェクトは、元の受信者とは異なる場合があります。

議論

要素は、objects に表われるのと同じ順序で新しい配列に追加され、インデックスの count まで至りますが、それを含められません。

不変(immutable)の配列は、この方法で初期化された後は、変更できません。

このメソッドは、指定イニシャライザです。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

- initWithObjects:

- indexOfObjectIdenticalTo:

- initWithArray:

配列の照会

- containsObject:

指定されたオブジェクトが配列内に存在するかどうかを示すブール値を返します。

宣言

<< SWIFT >>

func containsObject(_ anObject: AnyObject) -> Bool

<< OBJECTIVE-C >>

- (BOOL)containsObject:(ObjectType)anObject

パラメータ

anObject

オブジェクト。

戻り値

配列の中に anObject がある場合は、YES、それ以外の場合は、NO。

議論

IsEqual: メッセージに引数として渡される、各配列の要素は、インデックス 0 から始まり、一致が見つかった場合、または配列の末端に到達するまで anObject に送り続けられます。(NSObject プロトコルで宣言された) isEqual が YES を返せば、オブジェクトは等しいと見なされます。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

- indexOfObject:

- count プロパティ

配列内のオブジェクトの数を返します。

宣言

<< SWIFT >>

var count: Int { get }

<< OBJECTIVE-C >>

@property(readonly) NSUInteger count

利用可能

OS X 10.0 以降で利用可能

- getObjects:

(OS X 10.6)

配列に含まれるすべてのオブジェクトを、aBuffer へコピーします。

廃止の文

代わりに getObjects:range: を使用して下さい。

宣言

<< SWIFT >>

func getObjects(_ objects: AutoreleasingUnsafeMutablePointer<AnyObject?>)

<< OBJECTIVE-C >>

- (void)getObjects:(ObjectType _Nonnull [])aBuffer

パラメータ

aBuffer

配列数の少なくともカウントのサイズのオブジェクトの C 言語の配列

議論

aBuffer に、配列内のすべてのオブジェクトをコピーするメソッド。バッファのサイズは、したがって、次の例に示すように、少なくともオブジェクト参照のサイズを掛けた配列の数でなければなりません(これは単なる一例であることに注意して下さい。配列の内容を、反復処理するために、単純にバッファを作成しないでください。)

NSArray *mArray = // ...;
id *objects;
NSUInteger count = [mArray count];
objects = malloc(sizeof(id) * count);
[mArray getObjects:objects];
for (i = 0; i < count; i++) {
NSLog(@"object at index %d: %@", i, objects[i]);
}
free(objects);

特別な考慮事項

潜在的にバッファオーバーランが発生する可能性があるため、旧式のメソッドは、安全ではありません。

利用可能

OS X 10.0 以降で利用可能

OS X 10.6 で旧式となりました。

以下も参照

+ arrayWithObjects:count:

- getObjects:range:

aBuffer に指定された範囲内にある配列に含まれるオブジェクトをコピーします。

宣言

<< SWIFT >>

func getObjects(_ objects: AutoreleasingUnsafeMutablePointer<AnyObject?>,
          range range: NSRange)

<< OBJECTIVE-C >>

- (void)getObjects:(ObjectType _Nonnull [])aBuffer
             range:(NSRange)aRange

- (void)getObjects:(id __unsafe_unretained [])objects range:()range

パラメータ

aBuffer	少なくとも aRange で指定された範囲の長さのサイズのオブジェクトの C の配列。
aRange	配列の境界内の範囲。範囲の長さに加えた位置が配列の数よりも大きい場合、このメソッドは NSRangeException エラーを発生させます。

議論

このメソッドは、aRange で指定された範囲内の配列の aBuffer オブジェクトにコピーします。そのため次の例に示すように、バッファのサイズは、少なくてもオブジェクト参照のサイズを掛けた範囲の長さでなければなりません(これは全くイラスト向きです - 配列の内容を読み書きするためだけに、通常はバッファを作成しないでしょう)。

NSArray *mArray = // an array with at least six elements...;
id *objects;
NSRange range = NSMakeRange(2, 4);
objects = malloc(sizeof(id) * range.length);
[mArray getObjects:objects range:range];
for (i = 0; i < range.length; i++) {
NSLog(@"objects: %@", objects[i]);
}
free(objects);

利用可能

OS X 10.0 以降で利用可能

以下も見よ

+ arrayWithObjects:count:

firstObject プロパティ

配列内の最初のオブジェクト。(読み取り専用)

宣言

<< SWIFT >>

var firstObject: AnyObject? { get }

<< OBJECTIVE-C >>

@property(nonatomic, readonly) ObjectType firstObject

議論

配列が空の場合、nil を返します。

利用可能

OS X 10.6 以降で利用可能

lastObject プロパティ

配列の最後のオブジェクト(読み取り専用)。

宣言

<< SWIFT >>

var lastObject: AnyObject? { get }

<< OBJECTIVE-C >>

@property(nonatomic, readonly) ObjectType lastObject

議論

配列が空の場合、nil を返します。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

removeLastObject (NSMutableArray)

- objectAtIndex:

指定されたインデックスに位置するオブジェクトを返します。

宣言

<< SWIFT >>

func objectAtIndex(_ index: Int) -> AnyObject

<< OBJECTIVE-C >>

- (ObjectType)objectAtIndex:(NSUInteger)index

パラメータ

index

配列の範囲内のインデックス。

戻り値

インデックスに位置するオブジェクト。

議論

指数 index が配列の最後を超えている場合(つまり、index が count で返される値に等しいかそれ以上の場合には) NSRangeException のエラーが発生します。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

- count

- objectsAtIndexes:

- objectAtIndexedSubscript:

指定されたインデックスにあるオブジェクトを返します。

宣言

<< SWIFT >>

subscript (_ idx: Int) -> AnyObject { get }

<< OBJECTIVE-C >>

- (ObjectType)objectAtIndexedSubscript:(NSUInteger)idx

パラメータ

idx

配列の範囲内のインデックス。

戻り値

index に位置するオブジェクト。

議論

指数index が配列の最後を超えている場合(つまり、index が count で返される値に等しいかそれ以上の場合には) NSRangeException のエラーが発生します。

このメソッドは、objectAtIndex:と同じです。

利用可能

OS X 10.8 以降で利用可能

以下も見よ

- count

- objectAtIndex:

- objectsAtIndexes:

与えられたインデックスセットで指定されたインデックスの配列内のオブジェクトを含む配列を返します。

宣言

<< SWIFT >>

func objectsAtIndexes(_ indexes: NSIndexSet) -> [AnyObject]

<< OBJECTIVE-C >>

- (NSArray<ObjectType> *)objectsAtIndexes:(NSIndexSet *)indexes

戻り値

indexes で指定されたインデックスの配列内のオブジェクトを含む配列。

議論

返されたオブジェクトは、indexes 内のそのインデックスの昇順のオブジェクトであるため、指数の高いインデックスを持つ返された配列内のそのオブジェクトは、indexes が小さいインデックスを持つオブジェクトに続きます。

indexes 内の任意の場所が配列の範囲を超えた場合や indexes が nil の時、NSRangeException エラーが発生します。

利用可能

OS X 10.4 以降で利用可能

以下も見よ

- count

- objectAtIndex:

- objectEnumerator

配列内の各オブジェクトにアクセスできる、列挙子オブジェクトを返します。

宣言

<< SWIFT >>

func objectEnumerator() -> NSEnumerator

<< OBJECTIVE-C >>

- (NSEnumerator<ObjectType> *)objectEnumerator

戻り値

配列内の各オブジェクトにアクセスできる、列挙子オブジェクトで、最小のインデックス位置にある要素から順番に上へとなっています。

議論

インデックス 0 の要素から始まって、順に、配列内の各オブジェクトにアクセスすることができる列挙子オブジェクトを返します。次のように：

NSEnumerator *enumerator = [myArray objectEnumerator];
id anObject;
while (anObject = [enumerator nextObject]) {
/* code to act on each element as it is returned */
}

特別な考慮事項

NSArray mutable サブクラスでこのメソッドを使用するときは、列挙中に配列を変更してはなりません。

高速列挙プロトコルを使用する方が効率的です(NSFastEnumeration を参照のこと)。高速列挙は、OS X v10.5 以降および iOS 2.0 以降で利用可能です。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

- reverseObjectEnumerator

nextObject (NSEnumerator)

- reverseObjectEnumerator

逆の順序で、配列内の各オブジェクトにアクセスすることができる列挙子オブジェクトを返します。

宣言

<< SWIFT >>

func reverseObjectEnumerator() -> NSEnumerator

<< OBJECTIVE-C >>

- (NSEnumerator<ObjectType> *)reverseObjectEnumerator

戻り値

最も高いインデックスにある要素からインデックス 0 の要素まで順番に下へと、配列内の各オブジェクトにアクセスできる、列挙子オブジェクト。

特別な考慮事項

NSArray の mutable サブクラスでこのメソッドを使用するときは、列挙中に配列を変更してはなりません。

高速列挙プロトコルを使用する方が効率的です(NSFastEnumeration を参照)。高速列挙は、OS X v10.5 以降および iOS 2.0 以降で利用可能です。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

- objectEnumerator

nextObject (NSEnumerator)

配列内のオブジェクトの検索

- indexOfObject:

与えられたオブジェクトと対応する配列の値が等しい最小のインデックスを返します。

宣言

<< SWIFT >>

func indexOfObject(_ anObject: AnyObject) -> Int

<< OBJECTIVE-C >>

- (NSUInteger)indexOfObject:(ObjectType)anObject

パラメータ

anObject

オブジェクト。

戻り値

対応する配列の値で最小のインデックスが anObject に等しいです。配列内のオブジェクトのどれもが anObject に等しくしない場合には、NSNotFound を返します。

議論

利用可能

OS X 10.0 以降で利用可能

以下も見よ

- containsObject:

- indexOfObjectIdenticalTo:

- indexOfObject:inRange:

与えられたオブジェクトと等しい対応する配列の指定された範囲内で最小のインデックスを返します。

宣言

<< SWIFT >>

func indexOfObject(_ anObject: AnyObject,
           inRange range: NSRange) -> Int

<< OBJECTIVE-C >>
- (NSUInteger)indexOfObject:(ObjectType)anObject
                    inRange:(NSRange)range

パラメータ

anObject	オブジェクト。
range	anObject を検索する中での配列内のインデックスの範囲。

戻り値

anObject に等しい、対応する配列の値の range 内で最小のインデックス。range 内のオブジェクトのどれも anObject に等しくしない場合には、NSNotFound を返します。

議論

range.location から始めて、IsEqual: メッセージが配列の各要素に渡され anObject に送信され、一致する物が見つかるか、範囲の終わりに到達するまで続けられます。isEqual: が YES を返す場合、オブジェクトは等しいと見なされます。

range パラメータが配列に存在しない範囲を表す場合は、このメソッドは NSRangeException のエラーを発生させます。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

- containsObject:

- indexOfObjectIdenticalTo:inRange:

- indexOfObjectIdenticalTo:

対応する配列の値が与えられたオブジェクトと一致する、最小のインデックスを返します。

宣言

<< SWIFT >>

func indexOfObjectIdenticalTo(_ anObject: AnyObject) -> Int

<< OBJECTIVE-C >>

- (NSUInteger)indexOfObjectIdenticalTo:(ObjectType)anObject

パラメータ

anObject

オブジェクト。

戻り値

対応する配列の値がが anObject と一致する最小のインデックス。配列内のオブジェクトのどれもが anObject と一致しない場合には、NSNotFound を返します。

議論

オブジェクトのアドレスが同じであればオブジェクトは同一であると見なされます。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

- containsObject:
- indexOfObject:

- indexOfObjectIdenticalTo:inRange:

対応する配列の値が、与えられたオブジェクトと等しく、指定された範囲内で最小のインデックスを返します。

宣言

<< SWIFT >>

func indexOfObjectIdenticalTo(_ anObject: AnyObject,
                      inRange range: NSRange) -> Int

<< OBJECTIVE-C >>
- (NSUInteger)indexOfObjectIdenticalTo:(ObjectType)anObject
                               inRange:(NSRange)range

パラメータ

anObject	オブジェクト。
range	anObject を検索する中での、配列内のインデックスの範囲。

戻り値

対応する配列値の range 内で anObject と一致する最低のインデックス。range 内のオブジェクトのどれもが anObject と一致しない場合には、NSNotFound を返します。

議論

オブジェクトのアドレスが一致すればオブジェクトは同一であると見なされます。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

- containsObject:
- indexOfObject:inRange:

- indexOfObjectPassingTest:

与えられたブロック内のテストに合格する、配列内の最初のオブジェクトのインデックスを返します。

宣言

<< SWIFT >>

func indexOfObjectPassingTest(_ predicate: (AnyObject,
                                         Int,
                                         UnsafeMutablePointer<ObjCBool>) -> Bool) -> Int

<< OBJECTIVE-C >>
- (NSUInteger)indexOfObjectPassingTest:(BOOL (^)(ObjectType obj,
                                   NSUInteger idx,
                                   BOOL *stop))predicate

パラメータ

predicate	配列内の要素に適用するブロック。ブロックは３つの引数を取ります。
	obj	配列内の要素。
	idx	配列内の要素のインデックス。
	stop	ブール値への参照。ブロックの、配列のさらなる処理を停止するように値を YES に設定できます。stop 引数は、out だけの引数です。ブロック内では、YES にだけこのブール値を設定する必要があります。
	ブロック(block) は obj がテストに合格したかどうかを示すブール値を返します。YES が返ると、配列のさらなる処理を停止します。

戻り値

predicate で指定されたテストに合格した、配列内の対応する値の最小のインデックス。配列内のオブジェクトが全てテストに合格しなかった場合、NSNotFound を返します。

議論

block パラメータが nil の場合、このメソッドは例外を発生させます。

利用可能

OS X 10.6 以降で利用可能

- indexOfObjectWithOptions:passingTest:

与えられた列挙オプションのセットに対して与えられたブロック内のテストに合格する、配列内のオブジェクトのインデックスを返します。

宣言

<< SWIFT >>

func indexOfObjectWithOptions(_ opts: NSEnumerationOptions,
                    passingTest predicate: (AnyObject,
                                         Int,
                                         UnsafeMutablePointer<ObjCBool>) -> Bool) -> Int

<< OBJECTIVE-C >>
- (NSUInteger)indexOfObjectWithOptions:(NSEnumerationOptions)opts
                           passingTest:(BOOL (^)(ObjectType obj,
                                                 NSUInteger idx,
                                                 BOOL *stop))predicate

パラメータ

opts	列挙するためのオプションを指定するビットマスク(同時に実行されるべきか、逆の順序で実行されるべきかどうか)。
predicate	配列内の要素に適用するブロック。ブロックは３つの引数を取ります。
	obj	配列内の要素。
	idx	配列内の要素のインデックス。
	stop	ブール値への参照。ブロックは、配列のさらなる処理を停止するように値を YES に設定できます。stop 引数は、out だけの引数です。ブロック内では、YES にだけこのブール値を設定する必要があります。
	Block は obj がテストに合格したかどうかを示すブール値を返します。

戻り値

対応する配列内の値が、predicate と opts で指定されたテストに合格したかどうかのインデックス。opts ビットマスクが逆の順序を指定すると、一致した最後の項目が返されます。それ以外の場合は、最初に一致したオブジェクトのインデックスが返されます。配列内のオブジェクトが全てテストに合格しない場合、NSNotFound を返します。

議論

デフォルトでは、列挙は最初のオブジェクトから始まり、最後のオブジェクトまで、配列を連続的に続けます。この動作を変更するために列挙オプションとして NSEnumerationConcurrent および/または NSEnumerationReverse を指定できます。

重要：Block パラメータが nil の場合は、このメソッドでは例外が発生します。

利用可能

OS X 10.6 以降で利用可能

- indexOfObjectAtIndexes:options:passingTest:

列挙オプションの与えられたセットに対して与えられたブロック内のテストに合格した、配列内のオブジェクトのインデックスの与えられたセットから、インデックスを返します。

宣言

<< SWIFT >>

func indexOfObjectAtIndexes(_ s: NSIndexSet,
                        options opts: NSEnumerationOptions,
                    passingTest predicate: (AnyObject,
                                         Int,
                                         UnsafeMutablePointer<ObjCBool>) -> Bool) -> Int

<< OBJECTIVE-C >>
- (NSUInteger)indexOfObjectAtIndexes:(NSIndexSet *)indexSet
                             options:(NSEnumerationOptions)opts
                         passingTest:(BOOL (^)(ObjectType obj,
                                               NSUInteger idx,
                                               BOOL *stop))predicate

パラメータ

indexSet	列挙した上でのオブジェクトのインデックス。
opts	列挙するためのオプションを指定するビットマスク(同時に実行されるべきか、逆の順序で実行されるべきか)。
predicate	配列内の要素に適用するブロック。ブロックは３つの引数を取ります。
	obj	配列内の要素。
	idx	配列内の要素のインデックス。
	stop	ブール値への参照。ブロックは、配列のさらなる処理を停止するように値を YES に設定できます。stop 引数は、out だけの引数です。ブロック内ではこのブール値を YES にしか設定できません。
	ブロックは、obj がテストに合格したかどうかを示すブール値を返します。

戻り値

predicate で指定されたテストに合格する、対応した配列内の値で最小のインデックス。配列内のオブジェクトが全てテストに合格しない場合、NSNotFound を返します。

議論

デフォルトでは、列挙は最初のオブジェクトから始まり、indexSet で指定された最後の要素まで、配列を連続して続けられます。この動作を変更するために、列挙オプションとして NSEnumerationConcurrent および/または NSEnumerationReverse を指定することができます。

重要：ブロックパラメータまたは indexSet が nil の場合、このメソッドでは例外が発生します。

利用可能

OS X 10.6 以降で利用可能

- indexesOfObjectsPassingTest:

与えられたブロック内のテストに合格した、配列内のオブジェクトのインデックスを返します。

宣言

<< SWIFT >>

func indexesOfObjectsPassingTest(_ predicate: (AnyObject,
                                          Int,
                                          UnsafeMutablePointer<ObjCBool>) -> Bool) ->> NSIndexSet

<< OBJECTIVE-C >>
- (NSIndexSet *)indexesOfObjectsPassingTest:(BOOL (^)(ObjectType obj,
                                      NSUInteger idx,
                                      BOOL *stop))predicate

パラメータ

predicate	配列内の要素に適用するブロック。ブロックは３つの引数を取ります。
	obj	配列内の要素。
	idx	配列内の要素のインデックス。
	stop	ブール値への参照。ブロックの、配列のさらなる処理を停止するように値を YES に設定できます。stop 引数は、out だけの引数です。ブロック内では、YES にだけこのブール値を設定する必要があります。
	ブロックは obj がテストに合格したかどうかを示すブール値を返します。YES が返ると、配列のさらなる処理を停止します。

戻り値

その配列の、対応する値の断言(predicate)によって指定されたテストに合格したインデックス。テストに合格した配列内のオブジェクトがない場合は、空のインデックスセットを返します。

利用可能

OS X 10.6 以降で利用可能

- indexesOfObjectsWithOptions:passingTest:

列挙オプションの与えられたセットに対して与えられたブロック内のテストに合格した、配列内のオブジェクトのインデックスを返します。

宣言

<< SWIFT >>

func indexesOfObjectsWithOptions(_ opts: NSEnumerationOptions,
                     passingTest predicate: (AnyObject,
                                          Int,
                                          UnsafeMutablePointer%ltObjCBool>) -> Bool) -> NSIndexSet

<< OBJECTIVE-C >>
- (NSIndexSet *)indexesOfObjectsWithOptions:(NSEnumerationOptions)opts
                                passingTest:(BOOL (^)(ObjectType obj,
                                                      NSUInteger idx,
                                                      BOOL *stop))predicate

パラメータ

opts	列挙するためのオプションを指定するビットマスク(同時に実行されるべきか、逆の順序で実行されるべきかどうか)。
predicate	配列内の要素に適用するブロック。ブロックは３つの引数を取ります。
	obj	配列内の要素。
	idx	配列内の要素のインデックス。
	stop	ブール値への参照。ブロックは、配列のさらなる処理を停止するように値を YES に設定できます。stop 引数は、out だけの引数です。ブロック内では、YES にだけこのブール値を設定する必要があります。
	Block は obj がテストに合格したかどうかを示すブール値を返します。

戻り値

議論

デフォルトでは、列挙は最初のオブジェクトから始まり、最後のオブジェクトまで、配列を順次続けます。この動作を変更するには、列挙オプションとして NSEnumerationConcurrent および/または NSEnumerationReverse を指定することができます。

重要：ブロックパラメータが nilの場合、このメソッドでは例外が発生します。

利用可能

OS X 10.6 以降で利用可能

- indexesOfObjectsAtIndexes:options:passingTest:

列挙オプションの与えられたセットに対して与えられたブロック内のテストに合格した配列内のオブジェクトのインデックスの与えられたセットから、インデックスを返します。

宣言

<< SWIFT >>

func indexesOfObjectsAtIndexes(_ s: NSIndexSet,
                        options opts: NSEnumerationOptions,
                    passingTest predicate: (AnyObject,
                                         Int,
                                         UnsafeMutablePointer<ObjCBool>) -> Bool) -> NSIndexSet

<< OBJECTIVE-C >>
- (NSIndexSet *)indexesOfObjectsAtIndexes:(NSIndexSet *)indexSet
                                  options:(NSEnumerationOptions)opts
                              passingTest:(BOOL (^)(ObjectType obj,
                                                    NSUInteger idx,
                                                    BOOL *stop))predicate

パラメータ

indexSet	列挙した上でのオブジェクトのインデックス。
opts	列挙するためのオプションを指定するビットマスク(同時に実行されるべきか、逆の順序で実行されるべきか)。
predicate	配列内の要素に適用するブロック。ブロックは３つの引数を取ります。
	obj	配列内の要素。
	idx	配列内の要素のインデックス。
	stop	ブール値への参照。ブロックは、配列のさらなる処理を停止するように値を YES に設定できます。stop 引数は、out だけの引数です。ブロック内ではこのブール値を YES にしか設定できません。
	ブロックは、obj がテストに合格したかどうかを示すブール値を返します。

戻り値

対応する配列内の値が predicate によって指定されたテストに合格したかを示すインデックスです。配列内のオブジェクトが全て、テストに合格しなかった場合は、空のインデックスセットを返します。

議論

デフォルトでは、列挙は最初のオブジェクトから始まり、indexSet で指定された最後の要素まで、配列を順次続けます。この動作を変更するために列挙オプションとして NSEnumerationConcurrent および/または NSEnumerationReverse を指定することができます。

重要：ブロックパラメータまたは indexSet が nilの場合、このメソッドでは例外が発生します。

利用可能

OS X 10.6 以降で利用可能

- indexOfObject:inSortedRange:options:usingComparator:

与えられた NSComparator ブロックを使用して、配列内の要素と比較した、オブジェクトの指定した範囲内のインデックスを返します。

宣言

<< SWIFT >>

func indexOfObject(_ obj: AnyObject,
     inSortedRange r: NSRange,
           options opts: NSBinarySearchingOptions,
   usingComparator cmp: NSComparator) -> Int

<< OBJECTIVE-C >>
- (NSUInteger)indexOfObject:(ObjectType)obj
              inSortedRange:(NSRange)r
                    options:(NSBinarySearchingOptions)opts
            usingComparator:(NSComparator)cmp

パラメータ

obj	配列内を検索するために使われるオブジェクト。この値が nil の場合、NSInvalidArgumentException の例外が起こります。
r	obj を検索するための配列内の範囲。 r が配列の範囲を超えた場合(範囲の長さプラス位置が配列の数よりも大きい場合)、 NSRangeException のエラーが起こります。
opts	検索のためのオプション。可能な値については、NSBinarySearchingOptions を参照してください。 NSBinarySearchingFirstEqual と NSBinarySearchingLastEqual の両方を指定した場合、NSInvalidArgumentException の例外が起こります。
cmp	配列の要素でオブジェクト obj を比較するために使用されるコンパレータブロックです。この値が NULL の場合、NSInvalidArgumentException の例外が起こります。

戻り値

NSBinarySearchingInsertionIndex オプションが指定されていない場合：

obj が見つかり、NSBinarySearchingFirstEqual も NSBinarySearchingLastEqual も指定されていない場合、任意の一致するオブジェクトのインデックスを返します。

NSBinarySearchingFirstEqual オプションも指定されている場合は、一致したオブジェクトのうち最小のインデックスを返します。

NSBinarySearchingLastEqual オプションも指定されている場合は、一致したオブジェクトのうち最大インデックスを返します。

オブジェクトが見つからない場合は、NSNotFound を返します。

NSBinarySearchingInsertionIndex オプションが指定されている場合は、ソートされた配列を維持するために、obj を挿入する位置のインデックスを返します。

obj が見つかり、NSBinarySearchingFirstEqual も NSBinarySearchingLastEqual も指定されていない場合、一致するすべてのオブジェクトのインデックスと同じか1より大きいインデックスを返します。

NSBinarySearchingFirstEqual オプションも指定されている場合は、一致したオブジェクトのうち最小のインデックスを返します。

NSBinarySearchingLastEqual オプションも指定されている場合は、一致したオブジェクトのうち最大のインデックスを返します。

オブジェクトが見つからない場合は、オブジェクトが他のすべての要素よりも大きい場合は、配列の最後のインデックスか、少なくとも大きなオブジェクトのインデックスを返します。

特別な考慮事項

配列内の要素は、すでにコンパレータ cmp を使用してソートされている必要があります。配列がソートされていない場合、結果は未定義です。

利用可能

OS X 10.6 以降で利用可能

メッセージを要素に送信

- makeObjectsPerformSelector:

配列内の各々のオブジェクトに、与えられたセレクタで識別されるメッセージを送信し、最初のオブジェクトで始まり、最後のオブジェクトまで続く配列。

宣言

<< OBJECTIVE-C >>

- (void)makeObjectsPerformSelector:(SEL)aSelector

パラメータ

aSelector

配列内のオブジェクトに送信するメッセージを識別するセレクタ。メソッドは引数を取ってはならず、受信配列を変更するという副作用があってはなりません。

議論

aSelector が NULL の場合、このメソッドは NSInvalidArgumentException の例外を発生させます。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

配列内の各オブジェクトに aSelector メッセージを送信し、最初のオブジェクトから始まり、最後のオブジェクトまで続きます。

宣言

<< OBJECTIVE-C >>

- (void)makeObjectsPerformSelector:(SEL)aSelector
	 			withObject:(id)anObject

パラメータ

aSelector	配列内のオブジェクトに送信するメッセージを識別するセレクタ。このメソッドは、id 型の単一の引数を取る必要があり、受信配列を変更するという副作用があってはなりません。
anObject	aSelector メソッドを呼び出すたびに引数として送信するオブジェクト。

議論

aSelector が NULL の場合、このメソッドは NSInvalidArgumentException の例外を発生させます。

利用可能

OS X 10.0 以降で利用可能

以下も見よ

- enumerateObjectsWithOptions:usingBlock:

- enumerateObjectsUsingBlock:

最初のオブジェクトから始まり、最後のオブジェクトまで配列を反復継続して、配列内の各オブジェクトを使用して、与えられたブロックを実行します。

宣言

<< SWIFT >>

func enumerateObjectsUsingBlock(_ block: (AnyObject,
                                         Int,
                                         UnsafeMutablePointer<ObjCBool>) -> Void)

<< OBJECTIVE-C >>
- (void)enumerateObjectsUsingBlock:(void (^)(ObjectType obj,
                                     NSUInteger idx,
                                     BOOL *stop))block

パラメータ

block	配列内の要素に適用するブロック。ブロックは３つの引数を取ります。
	obj	配列内の要素。
	idx	配列内の要素のインデックス。
	stop	ブール値への参照。ブロックは、配列のさらなる処理を停止するように値を YES に設定できます。stop 引数は、out だけの引数です。ブロック内でこのブール値を YES にしか設定できません。

議論

Block パラメータが nil の場合、このメソッドでは例外が発生します。ブロックが実行された後、ブロック内に割り当てられた値は、割り当て解除されます。明示的にこれらの値を維持するためには、retain を使用してください。

このメソッドは同期的に実行されます。

利用可能

OS X 10.6 以降で利用可能

以下も見よ

- enumerateObjectsUsingBlock:

- enumerateObjectsWithOptions:usingBlock:

配列内の各オブジェクトを使用して、与えられたブロックを実行します。

宣言

<< SWIFT >>

func enumerateObjectsWithOptions(_ opts: NSEnumerationOptions,
                      usingBlock block: (AnyObject,
                                          Int,
                                          UnsafeMutablePointer<ObjCBool>) -> Void)

<< OBJECTIVE-C >>
- (void)enumerateObjectsWithOptions:(NSEnumerationOptions)opts
                         usingBlock:(void (^)(ObjectType obj,
                                              NSUInteger idx,
                                              BOOL *stop))block

パラメータ

opts	列挙するためのオプション(同時に実行されるべきか、逆の順序で実行されるべきか) を指定するビットマスク。
block	配列内の要素に適用するブロック。ブロックは３つの引数を取ります。
	obj	配列内の要素。
	idx	配列内の要素のインデックス。
	stop	ブール値への参照。ブロックは、配列のさらなる処理を停止するように値を YES に設定できます。stop 引数は、out だけの引数です。ブロック内ではこのブール値を YES にしか設定できません。

議論

デフォルトでは、列挙は最初のオブジェクトから始まり、最後のオブジェクトまで、配列を順次続けます。この動作を変更するために列挙オプションとして NSEnumerationConcurrent および/または NSEnumerationReverse を指定できます。

このメソッドは同期的に実行されます。

重要：Block パラメータが nil の場合、このメソッドでは例外が発生します。

利用可能

OS X 10.6 以降で利用可能

以下も見よ

- enumerateObjectsUsingBlock:

- enumerateObjectsAtIndexes:options:usingBlock:

指定されたインデックスで配列内のオブジェクトを使用して、与えられたブロックを実行します。

宣言

<< SWIFT >>

func enumerateObjectsAtIndexes(_ s: NSIndexSet,
                        options opts: NSEnumerationOptions,
                     usingBlock block: (AnyObject,
                                         Int,
                                         UnsafeMutablePointer<ObjCBool>) -> Void)

<< OBJECTIVE-C >>
- (void)enumerateObjectsAtIndexes:(NSIndexSet *)indexSet
                          options:(NSEnumerationOptions)opts
                       usingBlock:(void (^)(ObjectType obj,
                                            NSUInteger idx,
                                            BOOL *stop))block

パラメータ

indexSet	その上に列挙すべき、オブジェクトのインデックス。
opts	列挙するためのオプション(同時に実行されるべきか、逆の順序で実行されるべきか) を指定するビットマスク。
block	配列内の要素に適用するブロック。ブロックは３つの引数を取ります。
	obj	配列内の要素。
	idx	配列内の要素のインデックス。
	stop	ブール値への参照。ブロックは、配列のさらなる処理を停止するように値を YES に設定できます。stop 引数は、out だけの引数です。ブロック内ではこのブール値を YES にしか設定できません。

議論

デフォルトでは、列挙は最初のオブジェクトから始まり、indexSet で指定された最後の要素まで、配列を順次続けます。この動作を変更するために、列挙のオプションとして NSEnumerationConcurrent および/または NSEnumerationReverse を指定できます。

このメソッドは同期的に実行されます。

重要：ブロックパラメータまたは indexSet が nil の場合は、このメソッドでは例外が発生します。

利用可能

OS X 10.6 以降で利用可能

以下も見よ