Samond Classes Library 1.1.6-RELEASE build 132

SCBidirectionalList Class Reference

Bidirectional objects list class. More...

#import <SCBidirectionalList.h>

Inheritance diagram for SCBidirectionalList:
SCList SCCollection SCObject <SCDictionaryObjectProtocol> <SCCodingProtocol> <SCStreamProtocol> <SCCollectionProtocol>

List of all members.

Public Member Functions

Querying List
(id) - lastObject
(NSString *) - lastString
(NSNumber *) - lastNumber
(SCByte) - lastByte
(SCUByte) - lastUByte
(SCShort) - lastShort
(SCUShort) - lastUShort
(SCInteger) - lastInteger
(SCUInteger) - lastUInteger
(SCLong) - lastLong
(SCULong) - lastULong
(char) - lastChar
(unichar) - lastUnichar
(const char *) - lastCharString
(BOOL) - lastBool
(SCFloat) - lastFloat
(SCDouble) - lastDouble
Controlling List
(id) - previousObject
Adding Objects
(void) - insertLastObject:
(void) - insertLastByte:
(void) - insertLastUByte:
(void) - insertLastShort:
(void) - insertLastUShort:
(void) - insertLastInteger:
(void) - insertLastUInteger:
(void) - insertLastLong:
(void) - insertLastULong:
(void) - insertLastChar:
(void) - insertLastUnichar:
(void) - insertLastCharString:
(void) - insertLastBool:
(void) - insertLastFloat:
(void) - insertLastDouble:
(void) - insertLastObjects:
(void) - insertLastObjectsFromCollection:
Removing Objects
(void) - removeLastObject
Replacing Objects
(void) - replaceLastObjectWithObject:
(void) - replaceLastObjectWithByte:
(void) - replaceLastObjectWithUByte:
(void) - replaceLastObjectWithShort:
(void) - replaceLastObjectWithUShort:
(void) - replaceLastObjectWithInteger:
(void) - replaceLastObjectWithUInteger:
(void) - replaceLastObjectWithLong:
(void) - replaceLastObjectWithULong:
(void) - replaceLastObjectWithChar:
(void) - replaceLastObjectWithUnichar:
(void) - replaceLastObjectWithCharString:
(void) - replaceLastObjectWithBool:
(void) - replaceLastObjectWithFloat:
(void) - replaceLastObjectWithDouble:
Copying Objects
(void) - duplicateLastObject

Static Public Member Functions

Creating List
(SCBidirectionalList *) + listWithDataDictionary:
(SCBidirectionalList *) + listWithDataDictionaryFromFile:
(SCBidirectionalList *) + listWithCoder:
(SCBidirectionalList *) + listWithContentsOfSerializedFile:
(SCBidirectionalList *) + listWithStream:
(SCBidirectionalList *) + listWithFileStream:
(SCBidirectionalList *) + list
(SCBidirectionalList *) + listWithListName:capacity:
(SCBidirectionalList *) + listWithListName:
(SCBidirectionalList *) + listWithCapacity:
(SCBidirectionalList *) + listWithDelegate:
(SCBidirectionalList *) + listWithDelegate:collection:
(SCBidirectionalList *) + listWithCollection:
(SCBidirectionalList *) + listWithDelegate:object:
(SCBidirectionalList *) + listWithObject:
(SCBidirectionalList *) + listWithDelegate:objects:
(SCBidirectionalList *) + listWithObjects:
(SCBidirectionalList *) + listWithList:

Detailed Description

Bidirectional objects list class.

Class represents the bidirectional objects list class - special collection of objects, which stored as a bidirectional (from previous to next item and from next item to previous) list.
Class was introduced in version 1.1.3.

Class declares the following properties:

Member Function Documentation

- (void) duplicateLastObject

Duplicates the last object of the receiving list.

Exceptions:
SCCollectionException- list error detected
- (void) insertLastBool: (BOOL)  boolean

Inserts the specified boolean value before the last object of the receiving list.

Parameters:
boolean- inserted value
Exceptions:
SCCollectionException- list error detected
- (void) insertLastByte: (SCByte)  byte

Inserts the specified signed 8-bit integer value before the last object of the receiving list.

Parameters:
byte- inserted value
Exceptions:
SCCollectionException- list error detected
- (void) insertLastChar: (char)  chr

Inserts the specified char value before the last object of the receiving list.

Parameters:
chr- inserted value
Exceptions:
SCCollectionException- list error detected
- (void) insertLastCharString: (const char *)  string

Inserts the specified char string before the last object of the receiving list.

Parameters:
string- inserted string
Exceptions:
SCCollectionException- list error detected
- (void) insertLastDouble: (SCDouble)  dbl

Inserts the specified double precision float value before the last object of the receiving list.

Parameters:
dbl- inserted value
Exceptions:
SCCollectionException- list error detected
- (void) insertLastFloat: (SCFloat)  flt

Inserts the specified single precision float value before the last object of the receiving list.

Parameters:
flt- inserted value
Exceptions:
SCCollectionException- list error detected
- (void) insertLastInteger: (SCInteger)  integer

Inserts the specified signed 32-bit integer value before the last object of the receiving list.

Parameters:
integer- inserted value
Exceptions:
SCCollectionException- list error detected
- (void) insertLastLong: (SCLong)  longint

Inserts the specified signed 64-bit integer value before the last object of the receiving list.

Parameters:
longint- inserted value
Exceptions:
SCCollectionException- list error detected
- (void) insertLastObject: (id)  object

Inserts the specified object before the last object of the receiving list.

Parameters:
object- inserted object
Exceptions:
SCCollectionException- list error detected
- (void) insertLastObjects: (id)  object
,   ... 

Inserts the specified objects before the last object of the receiving list.

Parameters:
object- first inserted object
...- other inserted objects from nil terminated list
Exceptions:
SCCollectionException- list error detected
- (void) insertLastObjectsFromCollection: (id)  collection

Inserts the objects from the specified collection before the last object of the receiving list.

Parameters:
collection- source collection
Exceptions:
SCCollectionException- list error detected
- (void) insertLastShort: (SCShort)  shortint

Inserts the specified signed 16-bit integer value before the last object of the receiving list.

Parameters:
shortint- inserted value
Exceptions:
SCCollectionException- list error detected
- (void) insertLastUByte: (SCUByte)  byte

Inserts the specified unsigned 8-bit integer value before the last object of the receiving list.

Parameters:
byte- inserted value
Exceptions:
SCCollectionException- list error detected
- (void) insertLastUInteger: (SCUInteger)  integer

Inserts the specified unsigned 32-bit integer value before the last object of the receiving list.

Parameters:
integer- inserted value
Exceptions:
SCCollectionException- list error detected
- (void) insertLastULong: (SCULong)  longint

Inserts the specified unsigned 64-bit integer value before the last object of the receiving list.

Parameters:
longint- inserted value
Exceptions:
SCCollectionException- list error detected
- (void) insertLastUnichar: (unichar)  chr

Inserts the specified unichar value before the last object of the receiving list.

Parameters:
chr- inserted value
Exceptions:
SCCollectionException- list error detected
- (void) insertLastUShort: (SCUShort)  shortint

Inserts the specified unsigned 16-bit integer value before the last object of the receiving list.

Parameters:
shortint- inserted value
Exceptions:
SCCollectionException- list error detected
- (BOOL) lastBool

Returns as a boolean value the last object from the receiving list.

Returns:
Last value from the receiving list
Exceptions:
SCCollectionException- list error detected
- (SCByte) lastByte

Returns as a signed 8-bit integer value the last object from the receiving list.

Returns:
Last value from the receiving list
Exceptions:
SCCollectionException- list error detected
- (char) lastChar

Returns as a char value the last object from the receiving list.

Returns:
Last value from the receiving list
Exceptions:
SCCollectionException- list error detected
- (const char *) lastCharString

Returns as a char string the last object from the receiving list.

Returns:
Last string from the receiving list
Exceptions:
SCCollectionException- list error detected
- (SCDouble) lastDouble

Returns as a double precision float value the last object from the receiving list.

Returns:
Last value from the receiving list
Exceptions:
SCCollectionException- list error detected
- (SCFloat) lastFloat

Returns as a single precision float value the last object from the receiving list.

Returns:
Last value from the receiving list
Exceptions:
SCCollectionException- list error detected
- (SCInteger) lastInteger

Returns as a signed 32-bit integer value the last object from the receiving list.

Returns:
Last value from the receiving list
Exceptions:
SCCollectionException- list error detected
- (SCLong) lastLong

Returns as a signed 64-bit integer value the last object from the receiving list.

Returns:
Last value from the receiving list
Exceptions:
SCCollectionException- list error detected
- (NSNumber *) lastNumber

Returns as a number the last object from the receiving list.

Returns:
Last number or nil if list is empty
Exceptions:
SCCollectionException- list error detected
- (id) lastObject

Returns the last object from the receiving list.

Returns:
Last object or nil if list is empty
- (SCShort) lastShort

Returns as a signed 16-bit integer value the last object from the receiving list.

Returns:
Last value from the receiving list
Exceptions:
SCCollectionException- list error detected
- (NSString *) lastString

Returns as a string the last object from the receiving list.

Returns:
Last string or nil if list is empty
Exceptions:
SCCollectionException- list error detected
- (SCUByte) lastUByte

Returns as an unsigned 8-bit integer value the last object from the receiving list.

Returns:
Last value from the receiving list
Exceptions:
SCCollectionException- list error detected
- (SCUInteger) lastUInteger

Returns as an unsigned 32-bit integer value the last object from the receiving list.

Returns:
Last value from the receiving list
Exceptions:
SCCollectionException- list error detected
- (SCULong) lastULong

Returns as an unsigned 64-bit integer value the last object from the receiving list.

Returns:
Last value from the receiving list
Exceptions:
SCCollectionException- list error detected
- (unichar) lastUnichar

Returns as an unichar value the last object from the receiving list.

Returns:
Last value from the receiving list
Exceptions:
SCCollectionException- list error detected
- (SCUShort) lastUShort

Returns as an unsigned 16-bit integer value the last object from the receiving list.

Returns:
Last value from the receiving list
Exceptions:
SCCollectionException- list error detected
+ (SCBidirectionalList *) list

Returns a list created by using the default settings.

Returns:
A created list
+ (SCBidirectionalList *) listWithCapacity: (SCULong)  capacity

Returns a list created by using the specified capacity.

Parameters:
capacity- list capacity
Returns:
A created list
+ (SCBidirectionalList *) listWithCoder: (NSCoder *)  coder

Returns a list created by using the specified coder.

Parameters:
coder- source coder
Returns:
A created list
+ (SCBidirectionalList *) listWithCollection: (id)  collection

Returns a list created by using the specified existing collection.

Parameters:
collection- existing collection
Returns:
A created list
Exceptions:
SCCollectionException- list error detected
+ (SCBidirectionalList *) listWithContentsOfSerializedFile: (NSString *)  path

Returns a list created by using the contents of serialized file with the specified path.

Parameters:
path- source serialized file path
Returns:
A created list
+ (SCBidirectionalList *) listWithDataDictionary: (NSDictionary *)  dictionary

Returns a list created by using the specified dictionary.

Parameters:
dictionary- source dictionary
Returns:
A created list
+ (SCBidirectionalList *) listWithDataDictionaryFromFile: (NSString *)  path

Returns a list created by using the dictionary from the specified file.

Parameters:
path- source dictionary file path
Returns:
A created list
+ (SCBidirectionalList *) listWithDelegate: (id<SCCollectionDelegate>)  delegate

Returns a list created by using the specified delegate object.

Parameters:
delegate- delegate object
Returns:
A created list
+ (SCBidirectionalList *) listWithDelegate: (id<SCCollectionDelegate>)  delegate
collection: (id)  collection 

Returns a list created by using the specified delegate object and existing collection.

Parameters:
delegate- delegate object
collection- existing collection
Returns:
A created list
Exceptions:
SCCollectionException- list error detected
+ (SCBidirectionalList *) listWithDelegate: (id<SCCollectionDelegate>)  delegate
object: (id)  object 

Returns a list created by using the delegate object and existing object.

Parameters:
delegate- delegate object
object- existing object
Returns:
A newly created
Exceptions:
SCCollectionException- list error detected
+ (SCBidirectionalList *) listWithDelegate: (id<SCCollectionDelegate>)  delegate
objects: (id)  object
,   ... 

Returns the list created by using the specified delegate object and list of existing objects.

Parameters:
delegate- delegate object
object- first existing object
...- other existing objects
Returns:
A created list
Exceptions:
SCCollectionException- list error detected
+ (SCBidirectionalList *) listWithFileStream: (NSString *)  path

Returns a list created from the stream file with the specified path.

Parameters:
path- stream file path
Returns:
A created list
Exceptions:
SCStreamException- stream operation error detected
+ (SCBidirectionalList *) listWithList: (SCList *)  list

Returns the list created by using the existing list.

Parameters:
list- source list
Returns:
A created list
Exceptions:
SCCollectionError- list error detected
+ (SCBidirectionalList *) listWithListName: (NSString *)  name

Returns a list created by using the specified name.

Parameters:
name- list name
Returns:
A created list
+ (SCBidirectionalList *) listWithListName: (NSString *)  name
capacity: (SCULong)  capacity 

Returns a list created by using the specified name and capaicty.

Parameters:
name- list name
capacity- list capacity
Returns:
A created list
+ (SCBidirectionalList *) listWithObject: (id)  object

Returns a list created by using the existing object.

Parameters:
object- existing object
Returns:
A newly created
Exceptions:
SCCollectionException- list error detected
+ (SCBidirectionalList *) listWithObjects: (id)  object
,   ... 

Returns the list created by using the specified list of existing objects.

Parameters:
object- first existing object
...- other existing objects
Returns:
A created list
Exceptions:
SCCollectionException- list error detected
+ (SCBidirectionalList *) listWithStream: (SCStream *)  stream

Returns a list created from the specified stream.

Parameters:
stream- stream for reading list
Returns:
A created list
Exceptions:
SCStreamException- stream operation error detected
SCSystemException- system error detected
- (id) previousObject

Shifts the current object pointer to the previous object in the receiving list and return a pointer to the previous object.

Returns:
Pointer of the previous object or nil if the current object is the first object in the list
- (void) removeLastObject

Removes the last objects of the receiving list.

Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithBool: (BOOL)  boolean

Replaces the last object of receiving list with the specified boolean value.

Parameters:
boolean- replacing value
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithByte: (SCByte)  byte

Replaces the last object of receiving list with the specified signed 8-bit integer value.

Parameters:
byte- replacing value
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithChar: (char)  chr

Replaces the last object of receiving list with the specified char value.

Parameters:
chr- replacing value
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithCharString: (const char *)  string

Replaces the last object of receiving list with the specified character string.

Parameters:
string- replacing string
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithDouble: (SCDouble)  dbl

Replaces the last object of receiving list with the specified double precision float value.

Parameters:
dbl- replacing value
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithFloat: (SCFloat)  flt

Replaces the last object of receiving list with the specified single precision float value.

Parameters:
flt- replacing value
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithInteger: (SCInteger)  integer

Replaces the last object of receiving list with the specified signed 32-bit integer value.

Parameters:
integer- replacing value
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithLong: (SCLong)  longint

Replaces the last object of receiving list with the specified signed 64-bit integer value.

Parameters:
longint- replacing value
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithObject: (id)  object

Replaces the last object of receiving collection with the specified object.

Parameters:
object- replacing object
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithShort: (SCShort)  shortint

Replaces the last object of receiving list with the specified signed 16-bit integer value.

Parameters:
shortint- replacing value
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithUByte: (SCUByte)  byte

Replaces the last object of receiving list with the specified unsigned 8-bit integer value.

Parameters:
byte- replacing value
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithUInteger: (SCUInteger)  integer

Replaces the last object of receiving list with the specified unsigned 32-bit integer value.

Parameters:
integer- replacing value
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithULong: (SCULong)  longint

Replaces the last object of receiving list with the specified unsigned 64-bit integer value.

Parameters:
longint- replacing value
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithUnichar: (unichar)  chr

Replaces the last object of receiving list with the specified unichar value.

Parameters:
chr- replacing value
Exceptions:
SCCollectionException- list error detected
- (void) replaceLastObjectWithUShort: (SCUShort)  shortint

Replaces the last object of receiving list with the specified unsigned 16-bit integer value.

Parameters:
shortint- replacing value
Exceptions:
SCCollectionException- list error detected
The documentation for this class was generated from the following files:
 All Classes Files Functions Typedefs Enumerations Enumerator Defines
Generated on Fri Nov 21 2014 15:25:33 for Samond Classes Library 1.1.6-RELEASE build 132 by  doxygen 1.7.3