Parent class of the object list classes. More...

#import <SCList.h>

Inheritance diagram for SCList:

Initializing Lists
(id)	- initWithName:

(id)	- initWithObject:

(id)	- initWithObjects:

(id)	- initWithCollection:

(id)	- initWithList:

(id)	- init

Querying a List
id	currentObject

NSString *	currentString

NSNumber *	currentNumber

id	firstObject

NSString *	firstString

NSNumber *	firstNumber

(SCByte)	- currentByte

(SCUByte)	- currentUByte

(SCShort)	- currentShort

(SCUShort)	- currentUShort

(SCInteger)	- currentInteger

(SCUInteger)	- currentUInteger

(SCLong)	- currentLong

(SCULong)	- currentULong

(char)	- currentChar

(unichar)	- currentUnichar

(const char *)	- currentCharString

(BOOL)	- currentBool

(SCFloat)	- currentFloat

(SCDouble)	- currentDouble

(SCByte)	- firstByte

(SCUByte)	- firstUByte

(SCShort)	- firstShort

(SCUShort)	- firstUShort

(SCInteger)	- firstInteger

(SCUInteger)	- firstUInteger

(SCLong)	- firstLong

(SCULong)	- firstULong

(char)	- firstChar

(unichar)	- firstUnichar

(const char *)	- firstCharString

(BOOL)	- firstBool

(SCFloat)	- firstFloat

(SCDouble)	- firstDouble

Copying Lists
(void)	- setList:

Comparing Lists
(BOOL)	- isEqualToList:

(BOOL)	- isEqualToContentsOfList:

List Control
(id)	- nextObject

Adding Objects
(void)	- insertCurrentObject:

(void)	- insertCurrentByte:

(void)	- insertCurrentUByte:

(void)	- insertCurrentShort:

(void)	- insertCurrentUShort:

(void)	- insertCurrentInteger:

(void)	- insertCurrentUInteger:

(void)	- insertCurrentLong:

(void)	- insertCurrentULong:

(void)	- insertCurrentChar:

(void)	- insertCurrentUnichar:

(void)	- insertCurrentCharString:

(void)	- insertCurrentBool:

(void)	- insertCurrentFloat:

(void)	- insertCurrentDouble:

(void)	- insertCurrentObjects:

(void)	- insertCurrentCollection:

(void)	- insertFirstObject:

(void)	- insertFirstByte:

(void)	- insertFirstUByte:

(void)	- insertFirstShort:

(void)	- insertFirstUShort:

(void)	- insertFirstInteger:

(void)	- insertFirstUInteger:

(void)	- insertFirstLong:

(void)	- insertFirstULong:

(void)	- insertFirstChar:

(void)	- insertFirstUnichar:

(void)	- insertFirstCharString:

(void)	- insertFirstBool:

(void)	- insertFirstFloat:

(void)	- insertFirstDouble:

(void)	- insertFirstObjects:

(void)	- insertFirstCollection:

Removing Objects
(void)	- removeCurrentObject

(void)	- removeFirstObject

Replacing Objects
(void)	- replaceCurrentObjectWithObject:

(void)	- replaceCurrentObjectWithByte:

(void)	- replaceCurrentObjectWithUByte:

(void)	- replaceCurrentObjectWithShort:

(void)	- replaceCurrentObjectWithUShort:

(void)	- replaceCurrentObjectWithInteger:

(void)	- replaceCurrentObjectWithUInteger:

(void)	- replaceCurrentObjectWithLong:

(void)	- replaceCurrentObjectWithULong:

(void)	- replaceCurrentObjectWithChar:

(void)	- replaceCurrentObjectWithUnichar:

(void)	- replaceCurrentObjectWithCharString:

(void)	- replaceCurrentObjectWithBool:

(void)	- replaceCurrentObjectWithFloat:

(void)	- replaceCurrentObjectWithDouble:

(void)	- replaceFirstObjectWithObject:

(void)	- replaceFirstObjectWithByte:

(void)	- replaceFirstObjectWithUByte:

(void)	- replaceFirstObjectWithShort:

(void)	- replaceFirstObjectWithUShort:

(void)	- replaceFirstObjectWithInteger:

(void)	- replaceFirstObjectWithUInteger:

(void)	- replaceFirstObjectWithLong:

(void)	- replaceFirstObjectWithULong:

(void)	- replaceFirstObjectWithChar:

(void)	- replaceFirstObjectWithUnichar:

(void)	- replaceFirstObjectWithCharString:

(void)	- replaceFirstObjectWithBool:

(void)	- replaceFirstObjectWithFloat:

(void)	- replaceFirstObjectWithDouble:

Copying Objects
(void)	- duplicateCurrentObject

(void)	- duplicateFirstObject

Additional Inherited Members
Instance Methods inherited from SCCollection
(void)	- setCollection:

(void)	- setObject:

(void)	- setObjects:

(BOOL)	- isEqualToCollection:

(BOOL)	- isEqual:

(void)	- enumerateWithDelegate:

(void)	- enumerate

(void)	- reverseEnumerateWithDelegate:

(void)	- reverseEnumerate

(void)	- addObjects:

(void)	- addByte:

(void)	- addUByte:

(void)	- addShort:

(void)	- addUShort:

(void)	- addInteger:

(void)	- addUInteger:

(void)	- addLong:

(void)	- addULong:

(void)	- addChar:

(void)	- addUnichar:

(void)	- addCharString:

(void)	- addBool:

(void)	- addFloat:

(void)	- addDouble:

(void)	- addCollection:

(void)	- removeObjectsWithClass:

(void)	- removeObjectsWithClassName:

(void)	- removeCollection:

(void)	- removeObject:

(void)	- removeByte:

(void)	- removeUByte:

(void)	- removeShort:

(void)	- removeUShort:

(void)	- removeInteger:

(void)	- removeUInteger:

(void)	- removeLong:

(void)	- removeULong:

(void)	- removeChar:

(void)	- removeUnichar:

(void)	- removeCharString:

(void)	- removeBool:

(void)	- removeFloat:

(void)	- removeDouble:

(void)	- removeObjects:

(BOOL)	- containsByte:

(BOOL)	- containsUByte:

(BOOL)	- containsShort:

(BOOL)	- containsUShort:

(BOOL)	- containsInteger:

(BOOL)	- containsUInteger:

(BOOL)	- containsLong:

(BOOL)	- containsULong:

(BOOL)	- containsChar:

(BOOL)	- containsUnichar:

(BOOL)	- containsCharString:

(BOOL)	- containsBool:

(BOOL)	- containsFloat:

(BOOL)	- containsDouble:

(BOOL)	- containsObjects:

(BOOL)	- containsCollection:

(BOOL)	- containsAnyObject:

(BOOL)	- containsAnyObjectFromCollection:

(BOOL)	- isCollection

(BOOL)	- isLibraryCollection

(BOOL)	- isFoundationCollection

(BOOL)	- isArray

(BOOL)	- isLibraryArray

(BOOL)	- isFoundationArray

(BOOL)	- isSet

(BOOL)	- isLibrarySet

(BOOL)	- isFoundationSet

(BOOL)	- isOrderedSet

(BOOL)	- isLibraryOrderedSet

(BOOL)	- isFoundationOrderedSet

(BOOL)	- isDictionary

(BOOL)	- isLibraryDictionary

(BOOL)	- isFoundationDictionary

(BOOL)	- isStack

(BOOL)	- isQueue

(BOOL)	- isSortable

Instance Methods inherited from SCObject
(id)	- initWithContentsOfSerializedFile:

(BOOL)	- writeContentsToSerializedFile:

(id)	- initWithDataDictionaryFromFile:

(void)	- writeToDataDictionaryFile:atomically:

(void)	- writeToDataDictionaryFile:

(NSDictionary *)	- dataDictionary

(id)	- initWithFileStream:

(void)	- writeToFileStream:

(void)	- appendToFileStream:

Instance Methods inherited from <SCCoding>
Instance Methods inherited from <SCDictionaring>
Instance Methods inherited from <SCCollectioning>
Instance Methods inherited from <SCMutableCollection>
Instance Methods inherited from <SCCollection>
Class Methods inherited from SCCollection
(BOOL)	+ isCollectionClass:

(BOOL)	+ isLibraryCollectionClass:

(BOOL)	+ isFoundationCollectionClass:

(BOOL)	+ isArrayClass:

(BOOL)	+ isLibraryArrayClass:

(BOOL)	+ isFoundationArrayClass:

(BOOL)	+ isSetClass:

(BOOL)	+ isLibrarySetClass:

(BOOL)	+ isFoundationSetClass:

(BOOL)	+ isOrderedSetClass:

(BOOL)	+ isLibraryOrderedSetClass:

(BOOL)	+ isFoundationOrderedSetClass:

(BOOL)	+ isDictionaryClass:

(BOOL)	+ isLibraryDictionaryClass:

(BOOL)	+ isFoundationDictionaryClass:

(BOOL)	+ isStackClass:

(BOOL)	+ isQueueClass:

(BOOL)	+ isListClass:

(BOOL)	+ isSortableClass:

(BOOL)	+ isCollection:

(BOOL)	+ isLibraryCollection:

(BOOL)	+ isFoundationCollection:

(BOOL)	+ isArray:

(BOOL)	+ isLibraryArray:

(BOOL)	+ isFoundationArray:

(BOOL)	+ isSet:

(BOOL)	+ isLibrarySet:

(BOOL)	+ isFoundationSet:

(BOOL)	+ isOrderedSet:

(BOOL)	+ isLibraryOrderedSet:

(BOOL)	+ isFoundationOrderedSet:

(BOOL)	+ isDictionary:

(BOOL)	+ isLibraryDictionary:

(BOOL)	+ isFoundationDictionary:

(BOOL)	+ isStack:

(BOOL)	+ isQueue:

(BOOL)	+ isList:

(BOOL)	+ isSortable:

Properties inherited from SCCollection
NSString *	name

BOOL	readOnly

id< SCCollectionDelegate >	delegate

SCULong	count

BOOL	empty

NSString *	typeName

NSString *	description

NSEnumerator *	objectEnumerator

NSEnumerator *	reverseObjectEnumerator

Properties inherited from <SCCollection>
SCULong	count

BOOL	empty

NSString *	description

SCArray *	array

SCSet *	set

SCOrderedSet *	orderedSet

SCDictionary *	dictionary

SCStack *	stack

SCQueue *	queue

SCUnidirectionalList *	unidirectionalList

SCBidirectionalList *	bidirectionalList

NSArray *	foundationArray

NSSet *	foundationSet

NSOrderedSet *	foundationOrderedSet

NSDictionary *	foundationDictionary

NSEnumerator *	objectEnumerator

Detailed Description

Parent class of the object list classes.

Since: version 1.1.3

Class declares the common methods for classes, which represent the lists of objects.
Class instances can thrown the following exceptions:

Method Documentation

- (BOOL) currentBool

Returns the current object within the receiving list as a boolean value.

Returns: A current object or NO if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCByte) currentByte

Returns the current object within the receiving list as a signed 8-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (char) currentChar

Returns the current object within the receiving list as a character.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

See also: - currentUnichar

- (const char *) currentCharString

Returns the current object within the receiving list as a character string.

Returns: A current object or nil if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCDouble) currentDouble

Returns the current object within the receiving list as a double value.

Returns: A current object or 0.0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCFloat) currentFloat

Returns the current object within the receiving list as a float value.

Returns: A current object or 0.0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCInteger) currentInteger

Returns the current object within the receiving list as a signed 32-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCLong) currentLong

Returns the current object within the receiving list as a signed 64-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCShort) currentShort

Returns the current object within the receiving list as a signed 16-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCUByte) currentUByte

Returns the current object within the receiving list as an unsigned 8-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCUInteger) currentUInteger

Returns the current object within the receiving list as an unsigned 32-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCULong) currentULong

Returns the current object within the receiving list as an unsigned 64-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (unichar) currentUnichar

Returns the current object within the receiving list as a character.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

See also: - currentChar

- (SCUShort) currentUShort

Returns the current object within the receiving list as an unsigned 16-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (void) duplicateCurrentObject

Duplicates the current object within the receiving list.

Exceptions

SCCollectionException - collection error detected

- (void) duplicateFirstObject

Duplicates the first object within the receiving list.

Exceptions

SCCollectionException - collection error detected

- (BOOL) firstBool

Returns the first object within the receiving list as a boolean value.

Returns: A current object or NO if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCByte) firstByte

Returns the first object within the receiving list as a signed 8-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (char) firstChar

Returns the first object within the receiving list as a character.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

See also: - firstUnichar

- (const char *) firstCharString

Returns the first object within the receiving list as a character string.

Returns: A current object or nil if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCDouble) firstDouble

Returns the first object within the receiving list as a double value.

Returns: A current object or 0.0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCFloat) firstFloat

Returns the first object within the receiving list as a float value.

Returns: A current object or 0.0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCInteger) firstInteger

Returns the first object within the receiving list as a signed 32-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCLong) firstLong

Returns the first object within the receiving list as a signed 64-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCShort) firstShort

Returns the first object within the receiving list as a signed 16-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCUByte) firstUByte

Returns the first object within the receiving list as an unsigned 8-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCUInteger) firstUInteger

Returns the first object within the receiving list as an unsigned 32-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (SCULong) firstULong

Returns the first object within the receiving list as an unsigned 64-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (unichar) firstUnichar

Returns the first object within the receiving list as a character.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

See also: - firstChar

- (SCUShort) firstUShort

Returns the first object within the receiving list as an unsigned 16-bit integer value.

Returns: A current object or 0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (id) init

Initializes an empty unnamed list.

Returns: A newly initialized list

- (id) initWithCollection: (id) collection

Initializes a newly allocated list with objects from the specified collection of any supported type.

Parameters

collection - a collection with objects to add into the list

Returns: An initialized list with the objects from a given collection

Exceptions

SCCollectionException - collection error detected

Reimplemented from SCCollection.

- (id) initWithList: (SCList *) list

Initializes a newly allocated list by placing in it the objects contained in another given list.

Attention: Designed initializer

Parameters

list	- a list containing the objects with which to initialize the new list

Returns: An initialized list containing the objects found in the specified source list

Exceptions

SCCollectionException - collection error detected

- (id) initWithName: (NSString *) name

Initializes an empty list using the specified list name.

Attention: Designed initializer

Parameters

name	- the list name

Returns: A newly initialized list

- (id) initWithObject: (id) object

Initializes a newly allocated list containing a given object.

Parameters

object - the object to adding into the list

Returns: An initialized list containing a single object

- (id) initWithObjects:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

Initializes a newly allocated list containing objects from the specified list.

Parameters

object	- the first object to add into the list
...	- a null-terminated list of alternating objects to add into the list
NS_REQUIRES_NIL_TERMINATION	- the mandatory nil pointer

Returns: An initialized list containing the specified objects

- (void) insertCurrentBool: (BOOL) value

Inserts a given boolean value into the receiving list before the current object.

Parameters

value - the boolean value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentByte: (SCByte) value

Inserts a given signed 8-bit integer value into the receiving list before the current object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentChar: (char) value

Inserts a given character into the receiving list before the current object.

Parameters

value - the character to add into the list

Exceptions

SCCollectionException - collection error detected

See also: - insertCurrentUnichar:

- (void) insertCurrentCharString: (const char *) string

Inserts a given character string into the receiving list before the current object.

Parameters

string - the character string to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentCollection: (id) collection

Inserts the objects from the specified collection into the receiving list before the current object.

Parameters

collection - the collection of objects to add into the receiving list

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentDouble: (SCDouble) value

Inserts a given double value into the receiving list before the current object.

Parameters

value - the double value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentFloat: (SCFloat) value

Inserts a given float value into the receiving list before the current object.

Parameters

value - the float value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentInteger: (SCInteger) value

Inserts a given signed 32-bit integer value into the receiving list before the current object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentLong: (SCLong) value

Inserts a given signed 64-bit integer value into the receiving list before the current object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentObject: (id) object

Inserts a given object into the receiving list before the current object.

Parameters

object - the object to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentObjects:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

Inserts the objects from the specified list into the receiving list before the current object.

Parameters

object	- the first object to add into the list
...	- other objects from the null-terminated list to add into the receiving list
NS_REQUIRES_NIL_TERMINATION	- the mandatory nil pointer

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentShort: (SCShort) value

Inserts a given signed 16-bit integer value into the receiving list before the current object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentUByte: (SCUByte) value

Inserts a given unsigned 8-bit integer value into the receiving list before the current object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentUInteger: (SCUInteger) value

Inserts a given unsigned 32-bit integer value into the receiving list before the current object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentULong: (SCULong) value

Inserts a given unsigned 64-bit integer value into the receiving list before the current object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertCurrentUnichar: (unichar) value

Inserts a given character into the receiving list before the current object.

Parameters

value - the character to add into the list

Exceptions

SCCollectionException - collection error detected

See also: - insertCurrentChar:

- (void) insertCurrentUShort: (SCUShort) value

Inserts a given unsigned 16-bit integer value into the receiving list before the current object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstBool: (BOOL) value

Inserts a given boolean value into the receiving list before the first object.

Parameters

value - the boolean value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstByte: (SCByte) value

Inserts a given signed 8-bit integer value into the receiving list before the first object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstChar: (char) value

Inserts a given character into the receiving list before the first object.

Parameters

value - the character to add into the list

Exceptions

SCCollectionException - collection error detected

See also: - insertFirstUnichar:

- (void) insertFirstCharString: (const char *) string

Inserts a given character string into the receiving list before the first object.

Parameters

string - the character string to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstCollection: (id) collection

Inserts the objects from the specified collection into the receiving list before the first object.

Parameters

collection - the collection of objects to add into the receiving list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstDouble: (SCDouble) value

Inserts a given boolean value into the receiving list before the first object.

Parameters

value - the double value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstFloat: (SCFloat) value

Inserts a given float value into the receiving list before the first object.

Parameters

value - the float value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstInteger: (SCInteger) value

Inserts a given signed 32-bit integer value into the receiving list before the first object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstLong: (SCLong) value

Inserts a given signed 64-bit integer value into the receiving list before the first object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstObject: (id) object

Inserts a given object into the receiving list before the first object.

Parameters

object - the object to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstObjects:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

Inserts the objects from the specified list into the receiving list before the first object.

Parameters

object	- the first object to add into the list
...	- other objects from the null-terminated list to add into the receiving list
NS_REQUIRES_NIL_TERMINATION	- the mandatory nil pointer

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstShort: (SCShort) value

Inserts a given signed 16-bit integer value into the receiving list before the first object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstUByte: (SCUByte) value

Inserts a given unsigned 8-bit integer value into the receiving list before the first object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstUInteger: (SCUInteger) value

Inserts a given unsigned 32-bit integer value into the receiving list before the first object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstULong: (SCULong) value

Inserts a given unsigned 64-bit integer value into the receiving list before the first object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (void) insertFirstUnichar: (unichar) value

Inserts a given character into the receiving list before the first object.

Parameters

value - the character to add into the list

Exceptions

SCCollectionException - collection error detected

See also: - insertFirstChar:

- (void) insertFirstUShort: (SCUShort) value

Inserts a given unsigned 16-bit integer value into the receiving list before the first object.

Parameters

value - the value to add into the list

Exceptions

SCCollectionException - collection error detected

- (BOOL) isEqualToContentsOfList: (SCList *) list

Returns a boolean value that indicates whether the contents of the receiving list are equal to the contents of another given list.

Parameters

list	- the list with which to compare the receiving list

Returns: YES if the contents of the specified list are equal to the contents of the receiving list, otherwise NO

- (BOOL) isEqualToList: (SCList *) list

Returns a boolean value that indicates whether the settings and contents of the receiving list are equal to the settings and contents of another given list.

Parameters

list	- the list with which to compare the receiving list

Returns: YES if the settings and contents of the specified list are equal to the settings and contents of the receiving list, otherwise NO

- (id) nextObject

Shifts the current object pointer to the next object in the receiving list and returns a pointer to the next object.

Returns: A next object or nil if the current object is a last object within the list

- (void) removeCurrentObject

Removes from the receiving list the current object.

Exceptions

SCCollectionException - collection error detected

- (void) removeFirstObject

Removes the first object from the receiving list.

Exceptions

SCCollectionException - collection error detected

- (void) replaceCurrentObjectWithBool: (BOOL) value

Replaces the current object with a given boolean value.

Parameters

value - the boolean value with which to replace the current object

Exceptions

SCCollectionException - collection error detected

- (void) replaceCurrentObjectWithByte: (SCByte) value

Replaces the current object with a given signed 8-bit integer value.

Parameters

value - the value with which to replace the current object

Exceptions

SCCollectionException - collection error detected

- (void) replaceCurrentObjectWithChar: (char) value

Replaces the current object with a given character.

Parameters

value - the character with which to replace the current object

Exceptions

SCCollectionException - collection error detected

See also: - replaceCurrentObjectWithUnichar:

- (void) replaceCurrentObjectWithCharString: (const char *) string

Replaces the current object with a given character string.

Parameters

string - the character string with which to replace the current object

Exceptions

SCCollectionException - collection error detected

- (void) replaceCurrentObjectWithDouble: (SCDouble) value

Replaces the current object with a given double value.

Parameters

value - the double value with which to replace the current object

Exceptions

SCCollectionException - collection error detected

- (void) replaceCurrentObjectWithFloat: (SCFloat) value

Replaces the current object with a given float value.

Parameters

value - the float value with which to replace the current object

Exceptions

SCCollectionException - collection error detected

- (void) replaceCurrentObjectWithInteger: (SCInteger) value

Replaces the current object with a given signed 32-bit integer value.

Parameters

value - the value with which to replace the current object

Exceptions

SCCollectionException - collection error detected

- (void) replaceCurrentObjectWithLong: (SCLong) value

Replaces the current object with a given signed 64-bit integer value.

Parameters

value - the value with which to replace the current object

Exceptions

SCCollectionException - collection error detected

- (void) replaceCurrentObjectWithObject: (id) object

Replaces the current object with a given object.

Parameters

object - the object with which to replace the current object

Exceptions

SCCollectionException - collection error detected

- (void) replaceCurrentObjectWithShort: (SCShort) value

Replaces the current object with a given signed 16-bit integer value.

Parameters

value - the value with which to replace the current object

Exceptions

SCCollectionException - collection error detected

- (void) replaceCurrentObjectWithUByte: (SCUByte) value

Replaces the current object with a given unsigned 8-bit integer value.

Parameters

value - the value with which to replace the current object

Exceptions

SCCollectionException - collection error detected

- (void) replaceCurrentObjectWithUInteger: (SCUInteger) value

Replaces the current object with a given unsigned 32-bit integer value.

Parameters

value - the value with which to replace the current object

Exceptions

SCCollectionException - collection error detected

- (void) replaceCurrentObjectWithULong: (SCULong) value

Replaces the current object with a given unsigned 64-bit integer value.

Parameters

value - the value with which to replace the current object

Exceptions

SCCollectionException - collection error detected

- (void) replaceCurrentObjectWithUnichar: (unichar) value

Replaces the current object with a given character.

Parameters

value - the character with which to replace the current object

Exceptions

SCCollectionException - collection error detected

See also: - replaceCurrentObjectWithChar:

- (void) replaceCurrentObjectWithUShort: (SCUShort) value

Replaces the current object with a given unsigned 16-bit integer value.

Parameters

value - the value with which to replace the current object

Exceptions

SCCollectionException - collection error detected

- (void) replaceFirstObjectWithBool: (BOOL) value

Replaces the first object with a given boolean value.

Parameters

value - the boolean value with which to replace the first object

Exceptions

SCCollectionException - collection error detected

- (void) replaceFirstObjectWithByte: (SCByte) value

Replaces the first object with a given signed 8-bit integer value.

Parameters

value - the value with which to replace the first object

Exceptions

SCCollectionException - collection error detected

- (void) replaceFirstObjectWithChar: (char) value

Replaces the first object with a given character.

Parameters

value - the character with which to replace the first object

Exceptions

SCCollectionException - collection error detected

See also: - replaceFirstObjectWithUnichar:

- (void) replaceFirstObjectWithCharString: (const char *) string

Replaces the first object with a given character string.

Parameters

string - the character string with which to replace the first object

Exceptions

SCCollectionException - collection error detected

- (void) replaceFirstObjectWithDouble: (SCDouble) value

Replaces the first object with a given double value.

Parameters

value - the double value with which to replace the first object

Exceptions

SCCollectionException - collection error detected

- (void) replaceFirstObjectWithFloat: (SCFloat) value

Replaces the first object with a given float value.

Parameters

value - the float value with which to replace the first object

Exceptions

SCCollectionException - collection error detected

- (void) replaceFirstObjectWithInteger: (SCInteger) value

Replaces the first object with a given signed 32-bit integer value.

Parameters

value - the value with which to replace the first object

Exceptions

SCCollectionException - collection error detected

- (void) replaceFirstObjectWithLong: (SCLong) value

Replaces the first object with a given signed 64-bit integer value.

Parameters

value - the value with which to replace the first object

Exceptions

SCCollectionException - collection error detected

- (void) replaceFirstObjectWithObject: (id) object

Replaces the first object with a given object.

Parameters

object - the object with which to replace the first object

Exceptions

SCCollectionException - collection error detected

- (void) replaceFirstObjectWithShort: (SCShort) value

Replaces the first object with a given signed 16-bit integer value.

Parameters

value - the value with which to replace the first object

Exceptions

SCCollectionException - collection error detected

- (void) replaceFirstObjectWithUByte: (SCUByte) value

Replaces the first object with a given unsigned 8-bit integer value.

Parameters

value - the value with which to replace the first object

Exceptions

SCCollectionException - collection error detected

- (void) replaceFirstObjectWithUInteger: (SCUInteger) value

Replaces the first object with a given unsigned 32-bit integer value.

Parameters

value - the value with which to replace the first object

Exceptions

SCCollectionException - collection error detected

- (void) replaceFirstObjectWithULong: (SCULong) value

Replaces the first object with a given unsigned 64-bit integer value.

Parameters

value - the value with which to replace the first object

Exceptions

SCCollectionException - collection error detected

- (void) replaceFirstObjectWithUnichar: (unichar) value

Replaces the first object with a given character.

Parameters

value - the character with which to replace the first object

Exceptions

SCCollectionException - collection error detected

See also: - replaceFirstObjectWithChar:

- (void) replaceFirstObjectWithUShort: (SCUShort) value

Replaces the first object with a given unsigned 16-bit integer value.

Parameters

value - the value with which to replace the first object

Exceptions

SCCollectionException - collection error detected

- (void) setList: (SCList *) list

Sets the settings and contents of the receiving list to settings and objects in a given list.

Parameters

list	- the source list

Exceptions

SCCollectionException - collection error detected

Property Documentation

- (NSNumber *) currentNumber

readnonatomicretain

The current object within the list as a number

- (id) currentObject

readnonatomicretain

The current object within the list or nil if the list is empty

- (NSString *) currentString

readnonatomicretain

The current object within the list as a string

- (NSNumber *) firstNumber

readnonatomicretain

The first object within the list as a number

- (id) firstObject

readnonatomicretain

The first object within the list or if the list is empty

Returns the current object within the receiving list as a float value.

Returns: A current object or 0.0 if the list is empty

Exceptions

SCCollectionException - collection error detected

- (NSString *) firstString

readnonatomicretain

The first object within the list as a string

The documentation for this class was generated from the following files:

SCList.h
SCList.m

Initializing Lists

Querying a List

Copying Lists

Comparing Lists

List Control

Adding Objects

Removing Objects

Replacing Objects

Copying Objects

Additional Inherited Members

Detailed Description

Method Documentation

Property Documentation