Strings list class. More...

#import <SCStrings.h>

Inheritance diagram for SCStrings:

Public Member Functions
Initializing List
(id)	- initWithName:capacity:delegate:
(id)	- initWithName:capacity:
(id)	- initWithName:delegate:
(id)	- initWithName:
(id)	- initWithDelegate:
(id)	- initWithCapacity:
(id)	- init
(id)	- initWithString:
(id)	- initWithStrings:
(id)	- initWithCollection:
(id)	- initWithList:
Querying and Setting List Properties
(NSString *)	- textName
(SCULong)	- count
(BOOL)	- isReadOnly
(SCULong)	- capacity
(BOOL)	- isUnlimited
(SCLong)	- freeCount
(BOOL)	- freeItemsAvailable
(BOOL)	- isEmpty
(id< SCTextDelegate >)	- delegate
(BOOL)	- isModified
(BOOL)	- caseInsensitive
(BOOL)	- isUnique
(BOOL)	- isStrongUnique
(void)	- setTextName:
(void)	- setReadOnly:
(void)	- setCapacity:
(void)	- setDelegate:
(void)	- setCaseInsensitive:
(void)	- setUnique:
(void)	- setStrongUnique:
Setting and Copying Lists
(void)	- copyFromCollection:
(void)	- copyFromList:
(void)	- copyFromString:
(void)	- copyFromStrings:
(void)	- copySortedAscendingFromCollection:usingMethod:
(void)	- copySortedAscendingFromList:usingMethod:
(void)	- copySortedDescendingFromCollection:usingMethod:
(void)	- copySortedDescendingFromList:usingMethod:
(void)	- copySortedFromCollection:usingMethod:
(void)	- copySortedFromList:usingMethod:
(void)	- copySortedAscendingFromCollection:
(void)	- copySortedAscendingFromList:
(void)	- copySortedDescendingFromCollection:
(void)	- copySortedDescendingFromList:
(void)	- copySortedFromCollection:
(void)	- copySortedFromList:
Comparing Lists
(BOOL)	- isEqualToCollection:caseInsensitive:
(BOOL)	- isEqualToCollection:
(BOOL)	- isEqualToList:caseInsensitive:
(BOOL)	- isEqualToList:
(BOOL)	- isEqualToContentsOfCollection:caseInsensitive:
(BOOL)	- isEqualToContentsOfCollection:
(BOOL)	- isEqualToContentsOfList:caseInsensitive:
(BOOL)	- isEqualToContentsOfList:
(BOOL)	- isEqual:
Enumerating Lists
(NSEnumerator *)	- stringEnumerator
(NSEnumerator *)	- reverseStringEnumerator
(void)	- enumerateWithDelegate:
(void)	- enumerate
(void)	- reverseEnumerateWithDelegate:
(void)	- reverseEnumerate
Describing List
(NSString *)	- description
Converting List
(SCArray *)	- array
(SCSet *)	- set
(SCStack *)	- stack
(SCQueue *)	- queue
(SCDictionary *)	- dictionary
(SCUnidirectionalList *)	- unidirectionalList
(SCBidirectionalList *)	- bidirectionalList
(NSArray *)	- foundationArray
(NSSet *)	- foundationSet
(NSDictionary *)	- foundationDictionary
Sorting List
(void)	- sortingListAscendingWithMethod:
(void)	- sortingListDescendingWithMethod:
(void)	- sortingListWithMethod:
(void)	- sortingListAscending
(void)	- sortingListDescending
(void)	- sortingList
(SCStrings *)	- sortedListAscendingWithMethod:
(SCStrings *)	- sortedListDescendingWithMethod:
(SCStrings *)	- sortedListWithMethod:
(SCStrings *)	- sortedListAscending
(SCStrings *)	- sortedListDescending
(SCStrings *)	- sortedList
Adding Strings
(void)	- addString:
(void)	- addStrings:
(void)	- addStringsFromCollection:
(void)	- addStringsFromList:
(void)	- addLine
(void)	- insertString:atIndex:
(void)	- insertAtIndex:strings:
(void)	- insertStringsFromCollection:atIndex:
(void)	- insertStringsFromList:atIndex:
(void)	- insertAtIndexes:strings:
(void)	- insertStringsFromCollection:atIndexes:
(void)	- insertStringsFromList:atIndexes:
(void)	- insertLineAtIndex:
Removing Strings
(void)	- removeAllStrings
(void)	- removeFirstString
(void)	- removeLastString
(void)	- removeStringAtIndex:
(void)	- removeStringsAtIndexes:
(void)	- removeStringsEqualTo:caseInsensitive:
(void)	- removeStringsEqualTo:
(void)	- removeStringsInCollection:caseInsensitive:
(void)	- removeStringsInCollection:
(void)	- removeStringsInList:caseInsensitive:
(void)	- removeStringsInList:
(void)	- removeString:caseInsensitive:
(void)	- removeString:
(void)	- removeWithCaseInsensitive:strings:
(void)	- removeStrings:
(void)	- removeStringsWithSubstring:caseInsensitive:
(void)	- removeStringsWithSubstring:
(void)	- removeStringsNotAtIndexes:
(void)	- removeStringsNotEqualTo:caseInsensitive:
(void)	- removeStringsNotEqualTo:
(void)	- removeStringsNotInCollection:caseInsensitive:
(void)	- removeStringsNotInCollection:
(void)	- removeStringsNotInList:caseInsensitive:
(void)	- removeStringsNotInList:
(void)	- removeStringsWithoutSubstring:caseInsensitive:
(void)	- removeStringsWithoutSubstring:
(void)	- removeDuplicatedStrings
Replacing Strings
(void)	- replaceStringAtIndex:withString:
(void)	- replaceStringsAtIndexes:withStrings:
(void)	- replaceStringsAtIndexes:withStringsFromCollection:
(void)	- replaceStringsAtIndexes:withStringsFromList:
Moving and Copying Strings
(void)	- exchangeStringAtIndex:withStringAtIndex:
(void)	- duplicateStringAtIndex:
(void)	- duplicateAllStrings
(void)	- duplicate
(void)	- copyStringAtIndex:toIndex:
(void)	- moveStringAtIndex:toIndex:
(void)	- forwardMoveStringAtIndex:steps:
(void)	- forwardMoveStringAtIndex:
(void)	- backwardMoveStringAtIndex:steps:
(void)	- backwardMoveStringAtIndex:
(void)	- moveToFirstPositionStringAtIndex:
(void)	- moveToLastPositionStringAtIndex:
(void)	- reverse
(SCStrings *)	- reversedList
Querying List
(NSString *)	- firstString
(NSString *)	- lastString
(NSString *)	- stringAtIndex:
(SCStrings *)	- stringsAtIndexes:
Finding and Selecting Strings
(BOOL)	- containsString:caseInsensitive:
(BOOL)	- containsString:
(BOOL)	- containsWithCaseInsensitive:strings:
(BOOL)	- containsStrings:
(BOOL)	- containsStringsFromCollection:caseInsensitive:
(BOOL)	- containsStringsFromCollection:
(BOOL)	- containsStringsFromList:caseInsensitive:
(BOOL)	- containsStringsFromList:
(BOOL)	- containsWithCaseInsensitive:anyString:
(BOOL)	- containsAnyString:
(BOOL)	- containsAnyStringFromCollection:caseInsensitive:
(BOOL)	- containsAnyStringFromCollection:
(BOOL)	- containsAnyStringFromList:caseInsensitive:
(BOOL)	- containsAnyStringFromList:
(BOOL)	- containsSubstring:caseInsensitive:
(BOOL)	- containsSubstring:
(BOOL)	- containsWithCaseInsensitive:substrings:
(BOOL)	- containsSubstrings:
(BOOL)	- containsSubstringsFromCollection:caseInsensitive:
(BOOL)	- containsSubstringsFromCollection:
(BOOL)	- containsSubstringsFromList:caseInsensitive:
(BOOL)	- containsSubstringsFromList:
(BOOL)	- containsWithCaseInsensitive:anySubstring:
(BOOL)	- containsAnySubstring:
(BOOL)	- containsAnySubstringFromCollection:caseInsensitive:
(BOOL)	- containsAnySubstringFromCollection:
(BOOL)	- containsAnySubstringFromList:caseInsensitive:
(BOOL)	- containsAnySubstringFromList:
(BOOL)	- containsDuplicatedStrings
(SCIndex)	- indexOfString:caseInsensitive:
(SCIndex)	- indexOfString:
(SCIndex)	- indexOfString:fromIndex:caseInsensitive:
(SCIndex)	- indexOfString:fromIndex:
(SCIndex)	- indexOfLastString
(SCIndex)	- indexOfSubstring:caseInsensitive:
(SCIndex)	- indexOfSubstring:
(SCStrings *)	- stringsWithSubstring:caseInsensitive:
(SCStrings *)	- stringsWithSubstring:
(SCStrings *)	- stringsWithoutSubstring:caseInsensitive:
(SCStrings *)	- stringsWithoutSubstring:
(SCULong)	- countOfString:caseInsensitive:
(SCULong)	- countOfString:
(SCULong)	- countOfSubstring:caseInsensitive:
(SCULong)	- countOfSubstring:
(SCULong)	- countOfStringsWithSubstring:caseInsensitive:
(SCULong)	- countOfStringsWithSubstring:
Static Public Member Functions
Creating List
(SCStrings *)	+ listWithDataDictionary:
(SCStrings *)	+ listWithDataDictionaryFromFile:
(SCStrings *)	+ listWithCoder:
(SCStrings *)	+ listWithContentsOfSerializedFile:
(SCStrings *)	+ listWithStream:
(SCStrings *)	+ listWithFileStream:
(SCStrings *)	+ listWithName:capacity:delegate:
(SCStrings *)	+ listWithName:capacity:
(SCStrings *)	+ listWithName:delegate:
(SCStrings *)	+ listWithName:
(SCStrings *)	+ listWithDelegate:
(SCStrings *)	+ listWithCapacity:
(SCStrings *)	+ list
(SCStrings *)	+ listWithString:
(SCStrings *)	+ listWithStrings:
(SCStrings *)	+ listWithCollection:
(SCStrings *)	+ listWithList:

Detailed Description

Strings list class.

Class implements the list of strings as a single object.
Class was introduced in version 1.1.4.

Class declares the following properties:

NSString* textName - list name
SCULong count - items count (read only)
BOOL isReadOnly - read only flag
SCULong capacity - list capacity (maximum size)
BOOL isUnlimited - unlimited list size flag (read only)
SCLong freeCount - free items count (read only)
BOOL freeItemsAvailable - free items availability flag (read only)
BOOL isEmpty - empty list flag (read only)
NSString* description - string representation of the list (read only)
SCTextDelegate *delegate - list events delegate object
BOOL isModified - flag indicates presence of the unsaved changes (read only)
BOOL caseInsensitive - flag determines whether the search and comparison operations are case insensitive
BOOL isUnique - flag determines the possibility of adding to the list of duplicate strings
BOOL isStrongUnique - flag specifies response to adding of duplicate strings

Member Function Documentation

- (void) addLine

Adds into the receiving strings list the empty line.

Exceptions:

SCTextException - strings list error detected

- (void) addString: (NSString *) string

Adds into the receiving strings list the specified string.

Parameters:

string - added string

Exceptions:

SCTextException - strings list error detected

- (void) addStrings:	(NSString *)	string
,		...

Adds into the strings list the specified strings.

Parameters:

string	- first string
...	- other strings with nil terminate

Exceptions:

SCTextException - strings list error detected

- (void) addStringsFromCollection: (id) collection

Adds into the receiving strings list the strings from the specified existing collection.

Parameters:

collection - existing source collection

Exceptions:

SCTextException - strings list error detected

- (void) addStringsFromList: (SCStrings *) list

Adds into the receiving strings list the strings from the specified existing strings list.

Parameters:

list	- existing source strings list

Exceptions:

SCTextException - strings list error detected

- (SCArray *) array

Returns the array with the copy of all receiving strings list strings.

Returns:: Array with required strings

- (void) backwardMoveStringAtIndex: (SCIndex) index

Moves the string at the specified index to an one position to the bottom of the strings list.

Parameters:

index - moved string index

Exceptions:

SCTextException - strings list error detected

- (void) backwardMoveStringAtIndex:	(SCIndex)	index
steps:	(SCULong)	steps

Moves the string at the specified index to a given count of positions to the bottom of the list.

Parameters:

index	- moved string index
steps	- count of positions

Exceptions:

SCTextException - strings list error detected

- (SCBidirectionalList *) bidirectionalList

Returns the bidirectional list with the copy of all receiving strings list strings.

Returns:: Bidirectional list with required strings

- (SCULong) capacity

Returns the maximum size of the receiving strings list.

Returns:: List capacity

- (BOOL) caseInsensitive

Determines whether the search and comparison operations are case insensitive.

Returns:: YES if operations are case insensitive, otherwise NO

- (BOOL) containsAnyString:	(NSString *)	string
,		...

Returns a Boolean value that indicates whether the receiving strings list contains at least one string from the specified nil terminated list.

Parameters:

string	- fist desired string
...	- other desired string

Returns:: YES if at least one of given strings are present in the strings list, otherwise NO

See also:: - containsWithCaseInsensitive:anyString:

- (BOOL) containsAnyStringFromCollection: (id) collection

Returns a Boolean value that indicates whether the receiving strings list contains at least one object from the specified collection.

Parameters:

collection - source collection

Returns:: YES if at least one of given strings are present in the strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsAnyStringFromCollection:caseInsensitive:

- (BOOL) containsAnyStringFromCollection:	(id)	collection
caseInsensitive:	(BOOL)	value

Returns a Boolean value that indicates whether the receiving strings list contains at least one object from the specified collection. Case insensitively depends on the value of the specified flag.

Parameters:

collection	- source collection
value	- YES for the case insensitive comparison operations, otherwise NO

Returns:: YES if at least one of given strings are present in the strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsAnyStringFromCollection:

- (BOOL) containsAnyStringFromList: (SCStrings *) list

Returns a Boolean value that indicates whether the receiving strings list contains at least one string from the specified strings list.

Parameters:

list	- source strings list

Returns:: YES if at least one of given strings are present in the strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsAnyStringFromList:caseInsensitive:

- (BOOL) containsAnyStringFromList:	(SCStrings *)	list
caseInsensitive:	(BOOL)	value

Returns a Boolean value that indicates whether the receiving strings list contains at least one string from the specified strings list. Case insensitively depends on the value of the specified flag.

Parameters:

list	- source strings list
value	- YES for the case insensitive comparison operations, otherwise NO

Returns:: YES if at least one of given strings are present in the strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsAnyStringFromList:

- (BOOL) containsAnySubstring:	(NSString *)	substring
,		...

Returns a Boolean value that indicates whether the receiving strings list contains at least one substring from the specified nil terminated list.

Parameters:

substring	- first desired substring
...	- other desired substrings

Returns:: YES if the strings list contains at least one of the specified substrings, otherwise NO

See also:: - containsWithCaseInsensitive:anySubstring:

- (BOOL) containsAnySubstringFromCollection: (id) collection

Returns a Boolean value that indicates whether the receiving strings list contains at least one substring from the specified collection.

Parameters:

collection - collection with the desired substrings

Returns:: YES if the strings list contains at least one of the substrings from collection, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsAnySubstringFromCollection:caseInsensitive:

- (BOOL) containsAnySubstringFromCollection:	(id)	collection
caseInsensitive:	(BOOL)	value

Returns a Boolean value that indicates whether the receiving strings list contains at least one substring from the specified collection. Case insensitively depends on the value of the specified flag.

Parameters:

collection	- collection with the desired substrings
value	- YES for the case insensitive comparison operations, otherwise NO

Returns:: YES if the strings list contains at least one of the substrings from collection, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsAnySubstringFromCollection:

- (BOOL) containsAnySubstringFromList: (SCStrings *) list

Returns a Boolean value that indicates whether the receiving strings list contains at least one substring from the specified strings list.

Parameters:

list	- strings list with the desired substrings

Returns:: YES if the strings list contains at least one of the substrings from strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsAnySubstringFromList:caseInsensitive:

- (BOOL) containsAnySubstringFromList:	(SCStrings *)	list
caseInsensitive:	(BOOL)	value

Returns a Boolean value that indicates whether the receiving strings list contains at least one substring from the specified strings list. Case insensitively depends on the value of the specified flag.

Parameters:

list	- strings list with the desired substrings
value	- YES for the case insensitive comparison operations, otherwise NO

Returns:: YES if the strings list contains at least one of the substrings from strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsAnySubstringFromList:

- (BOOL) containsDuplicatedStrings

Returns a Boolean value that indicates whether the receiving strings list contains at least one duplicated string.

Returns:: YES if the strings list contains at least one duplicated string, otherwise NO

- (BOOL) containsString: (NSString *) string

Returns a Boolean value that indicates whether a given string is present in the receiving strings list.

Parameters:

string - desired string

Returns:: YES if a given string is present in the strings list, otherwise NO

See also:: - containsString:caseInsensitive:

- (BOOL) containsString:	(NSString *)	string
caseInsensitive:	(BOOL)	value

Returns a Boolean value that indicates whether a given string is present in the receiving strings list. Case insensitively depends on the value of the specified flag.

Parameters:

string	- desired string
value	- YES for the case insensitive comparison operations, otherwise NO

Returns:: YES if a given string is present in the strings list, otherwise NO

See also:: - containsString:

- (BOOL) containsStrings:	(NSString *)	string
,		...

Returns a Boolean value that indicates whether the receiving strings list contains the all strings from the specified nil terminated list.

Parameters:

string	- fist desired string
...	- other desired strings

Returns:: YES if all of given strings are present in the strings list, otherwise NO

See also:: - containsWithCaseInsensitive:strings:

- (BOOL) containsStringsFromCollection: (id) collection

Returns a Boolean value that indicates whether the receiving strings list contains the all strings from the specified collection.

Parameters:

collection - source collection

Returns:: YES if all of given strings are present in the strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsStringsFromCollection:caseInsensitive:

- (BOOL) containsStringsFromCollection:	(id)	collection
caseInsensitive:	(BOOL)	value

Returns a Boolean value that indicates whether the receiving strings list contains the all strings from the specified collection. Case insensitively depends on the value of the specified flag.

Parameters:

collection	- source collection
value	- YES for the case insensitive comparison operations, otherwise NO

Returns:: YES if all of given strings are present in the strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsStringsFromCollection:

- (BOOL) containsStringsFromList: (SCStrings *) list

Returns a Boolean value that indicates whether the receiving strings list contains the all strings from the specified strings list.

Parameters:

list	- source strings list

Returns:: YES if all of given strings are present in the strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

- (BOOL) containsStringsFromList:	(SCStrings *)	list
caseInsensitive:	(BOOL)	value

Returns a Boolean value that indicates whether the receiving strings list contains the all strings from the specified strings list. Case insensitively depends on the value of the specified flag.

Parameters:

list	- source strings list
value	- YES for the case insensitive comparison operations, otherwise NO

Returns:: YES if all of given strings are present in the strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

- (BOOL) containsSubstring: (NSString *) substring

Returns a Boolean value that indicates whether the receiving strings list contains the specified substring.

Parameters:

substring - desired substring

Returns:: YES if the substring is present in the strings list, otherwise NO

See also:: - containsSubstring:caseInsensitive:

- (BOOL) containsSubstring:	(NSString *)	substring
caseInsensitive:	(BOOL)	value

Returns a Boolean value that indicates whether the receiving strings list contains the specified substring. Case insensitively depends on the value of the specified flag.

Parameters:

substring	- desired substring
value	- YES for the case insensitive comparison operations, otherwise NO

Returns:: YES if the substring is present in the strings list, otherwise NO

See also:: - containsSubstring:

- (BOOL) containsSubstrings:	(NSString *)	substring
,		...

Returns a Boolean value that indicates whether the receiving strings list contains all of substrings from the specified nil terminated list.

Parameters:

substring	- first desired substring
...	- other desired substrings

Returns:: YES if the strings list contains all of the specified substrings, otherwise NO

See also:: - containsWithCaseInsensitive:substrings:

- (BOOL) containsSubstringsFromCollection: (id) collection

Returns a Boolean value that indicates whether the receiving strings list contains all of substrings from the specified collection.

Parameters:

collection - collection with the desired substrings

Returns:: YES if the strings list contains all of the substrings from collection, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsSubstringsFromCollection:caseInsensitive:

- (BOOL) containsSubstringsFromCollection:	(id)	collection
caseInsensitive:	(BOOL)	value

Returns a Boolean value that indicates whether the receiving strings list contains all of substrings from the specified collection. Case insensitively depends on the value of the specified flag.

Parameters:

collection	- collection with the desired substrings
value	- YES for the case insensitive comparison operations, otherwise NO

Returns:: YES if the strings list contains all of the substrings from collection, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsSubstringsFromCollection:

- (BOOL) containsSubstringsFromList: (SCStrings *) list

Returns a Boolean value that indicates whether the receiving strings list contains all of substrings from the specified strings list.

Parameters:

list	- strings list with the desired substrings

Returns:: YES if the strings list contains all of the substrings from strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsSubstringsFromList:caseInsensitive:

- (BOOL) containsSubstringsFromList:	(SCStrings *)	list
caseInsensitive:	(BOOL)	value

Returns a Boolean value that indicates whether the receiving strings list contains all of substrings from the specified strings list. Case insensitively depends on the value of the specified flag.

Parameters:

list	- strings list with the desired substrings
value	- YES for the case insensitive comparison operations, otherwise NO

Returns:: YES if the strings list contains all of the substrings from strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - containsSubstringsFromList:

- (BOOL) containsWithCaseInsensitive:	(BOOL)	value
anyString:	(NSString *)	string
,		...

Returns a Boolean value that indicates whether the receiving strings list contains at least one string from the specified nil terminated list. Case insensitively depends on the value of the specified flag.

Parameters:

value	- YES for the case insensitive comparison operations, otherwise NO
string	- fist desired string
...	- other desired string

Returns:: YES if at least one of given strings are present in the strings list, otherwise NO

See also:: - containsAnyString:

- (BOOL) containsWithCaseInsensitive:	(BOOL)	value
anySubstring:	(NSString *)	substring
,		...

Returns a Boolean value that indicates whether the receiving strings list contains at least one substring from the specified nil terminated list. Case insensitively depends on the value of the specified flag.

Parameters:

value	- YES for the case insensitive comparison operations, otherwise NO
substring	- first desired substring
...	- other desired substrings

Returns:: YES if the strings list contains at least one of the specified substrings, otherwise NO

See also:: - containsAnySubstring:

- (BOOL) containsWithCaseInsensitive:	(BOOL)	value
strings:	(NSString *)	string
,		...

Returns a Boolean value that indicates whether the receiving strings list contains the all strings from the specified nil terminated list. Case insensitively depends on the value of the specified flag.

Parameters:

value	- YES for the case insensitive comparison operations, otherwise NO
string	- fist desired string
...	- other desired strings

Returns:: YES if all of given strings are present in the strings list, otherwise NO

See also:: - containsStrings:

- (BOOL) containsWithCaseInsensitive:	(BOOL)	value
substrings:	(NSString *)	substring
,		...

Returns a Boolean value that indicates whether the receiving strings list contains all of substrings from the specified nil terminated list. Case insensitively depends on the value of the specified flag.

Parameters:

value	- YES for the case insensitive comparison operations, otherwise NO
substring	- first desired substring
...	- other desired substrings

Returns:: YES if the strings list contains all of the specified substrings, otherwise NO

See also:: - containsSubstrings:

- (void) copyFromCollection: (id) collection

Replaces the content and settings of the receiving strings list by using the specified existing collection.

Parameters:

collection - existing collection

Exceptions:

SCTextException - strings list error detected

- (void) copyFromList: (SCStrings *) list

Replaces the content and settings of the receiving strings list by using the specified existing strings list.

Parameters:

list	- existing strings list

Exceptions:

SCTextException - strings list error detected

- (void) copyFromString: (NSString *) string

Replaces the content of the receiving strings list by using the specified existing string.

Parameters:

string - existing string

Exceptions:

SCTextException - strings list error detected

- (void) copyFromStrings:	(NSString *)	string
,		...

Replaces the receiving strings list content by the strings from the specified nil terminated list.

Parameters:

string	- first source string
...	- other strings nil terminated list

Exceptions:

SCTextException - strings list error detected

- (void) copySortedAscendingFromCollection: (id) collection

Replaces the content and settings of the receiving strings list of ascending sorted content and settings from the specified existing collection with using the default sorting algorithm.

Parameters:

collection - existing collection

Exceptions:

SCCollectionException	- collection error detected
SCTextException	- strings list error detected

- (void) copySortedAscendingFromCollection:	(id)	collection
usingMethod:	(id<SCSortingProtocol>)	method

Replaces the content and settings of the receiving strings list of ascending sorted content and settings from the specified existing collection with using the specified sorting algorithm.

Parameters:

collection	- existing collection
method	- sorting algorithm

Exceptions:

SCCollectionException	- collection error detected
SCTextException	- strings list error detected

- (void) copySortedAscendingFromList: (SCStrings *) list

Replaces the content and settings of the receiving strings list of ascending sorted content and settings from the specified existing strings list with using the default sorting algorithm.

Parameters:

list	- existing strings list

Exceptions:

SCCollectionException	- collection error detected
SCTextException	- strings list error detected

- (void) copySortedAscendingFromList:	(SCStrings *)	list
usingMethod:	(id<SCSortingProtocol>)	method

Replaces the content and settings of the receiving strings list of ascending sorted content and settings from the specified existing strings list with using the specified sorting algorithm.

Parameters:

list	- existing strings list
method	- sorting algorithm

Exceptions:

SCCollectionException	- collection error detected
SCTextException	- strings list error detected

- (void) copySortedDescendingFromCollection: (id) collection

Replaces the content and settings of the receiving strings list of descending sorted content and settings from the specified existing collection with using the default sorting algorithm.

Parameters:

collection - existing collection

Exceptions:

SCCollectionException	- collection error detected
SCTextException	- strings list error detected

- (void) copySortedDescendingFromCollection:	(id)	collection
usingMethod:	(id<SCSortingProtocol>)	method

Replaces the content and settings of the receiving strings list of descending sorted content and settings from the specified existing collection with using the specified sorting algorithm.

Parameters:

collection	- existing collection
method	- sorting algorithm

Exceptions:

SCCollectionException	- collection error detected
SCTextException	- strings list error detected

- (void) copySortedDescendingFromList: (SCStrings *) list

Replaces the content and settings of the receiving strings list of descending sorted content and settings from the specified existing strings list with using the default sorting algorithm.

Parameters:

list	- existing strings list

Exceptions:

SCCollectionException	- collection error detected
SCTextException	- strings list error detected

- (void) copySortedDescendingFromList:	(SCStrings *)	list
usingMethod:	(id<SCSortingProtocol>)	method

Replaces the content and settings of the receiving strings list of descending sorted content and settings from the specified existing strings list with using the specified sorting algorithm.

Parameters:

list	- existing strings list
method	- sorting algorithm

Exceptions:

SCCollectionException	- collection error detected
SCTextException	- strings list error detected

- (void) copySortedFromCollection: (id) collection

Replaces the content and settings of the receiving strings list of ascending sorted content and settings from the specified existing collection with using the default sorting algorithm.

Parameters:

collection - existing collection

Exceptions:

SCCollectionException	- collection error detected
SCTextException	- strings list error detected

- (void) copySortedFromCollection:	(id)	collection
usingMethod:	(id<SCSortingProtocol>)	method

Replaces the content and settings of the receiving strings list of ascending sorted content and settings from the specified existing collection with using the specified sorting algorithm.

Parameters:

collection	- existing collection
method	- sorting algorithm

Exceptions:

SCCollectionException	- collection error detected
SCTextException	- strings list error detected

- (void) copySortedFromList: (SCStrings *) list

Replaces the content and settings of the receiving strings list of ascending sorted content and settings from the specified existing strings list with using the default sorting algorithm.

Parameters:

list	- existing strings list

Exceptions:

SCCollectionException	- collection error detected
SCTextException	- strings list error detected

- (void) copySortedFromList:	(SCStrings *)	list
usingMethod:	(id<SCSortingProtocol>)	method

Replaces the content and settings of the receiving strings list of ascending sorted content and settings from the specified existing strings list with using the specified sorting algorithm.

Parameters:

list	- existing strings list
method	- sorting algorithm

Exceptions:

SCCollectionException	- collection error detected
SCTextException	- strings list error detected

- (void) copyStringAtIndex:	(SCIndex)	index
toIndex:	(SCIndex)	destination

Copies the string at the specified index to a given destination index.

Parameters:

index	- source index
destination	- destination index

Exceptions:

SCTextException - strings list error detected

- (SCULong) count

Returns the count of string which stored in the receiving strings list.

Returns:: Strings count

- (SCULong) countOfString: (NSString *) string

Returns a count of strings from the receiving list which are equal to the specified string.

Parameters:

string - desired string

Returns:: Count of desired strings

See also:: - countOfString:caseInsensitive:

- (SCULong) countOfString:	(NSString *)	string
caseInsensitive:	(BOOL)	value

Returns a count of strings from the receiving list which are equal to the specified string. Case insensitively depends on the value of the specified flag.

Parameters:

string	- desired string
value	- YES for case insensitive comparison operations, otherwise NO

Returns:: Count of desired strings

See also:: - countOfString:

- (SCULong) countOfStringsWithSubstring: (NSString *) substring

Returns a count of strings from the receiving list which are contains at least one occurrency of the specified substring.

Parameters:

substring - desired substring

Returns:: Count of strings with the desired substring

See also:: - countOfStringsWithSubstring:caseInsensitive:

- (SCULong) countOfStringsWithSubstring:	(NSString *)	substring
caseInsensitive:	(BOOL)	value

Returns a count of strings from the receiving list which are contains at least one occurrency of the specified substring. Case insensitively depends on the value of the specified flag.

Parameters:

substring	- desired substring
value	- YES for case insensitive comparison operations, otherwise NO

Returns:: Count of strings with the desired substring

See also:: - countOfStringsWithSubstring:

- (SCULong) countOfSubstring: (NSString *) substring

Returns a count of substrings from the receiving list which are equal to the specified substring.

Parameters:

substring - desired string

Returns:: Count of desired substring

See also:: - countOfSubstring:caseInsensitive:

- (SCULong) countOfSubstring:	(NSString *)	substring
caseInsensitive:	(BOOL)	value

Returns a count of substrings from the receiving list which are equal to the specified substring. Case insensitively depends on the value of the specified flag.

Parameters:

substring	- desired string
value	- YES for case insensitive comparison operations, otherwise NO

Returns:: Count of desired substring

See also:: - countOfSubstring:

- (id< SCTextDelegate >) delegate

Returns the strings list events delegate object.

Returns:: Delegate object

- (NSString *) description

Returns the string with the receiving strings list description.

Returns:: List description string

- (SCDictionary *) dictionary

Returns the dictionary with the copy of all receiving strings list strings.

Returns:: Dictionary with required strings

- (void) duplicate

Duplicates content of the receving strings list.

Exceptions:

SCTextException - strings list error detected

- (void) duplicateAllStrings

Duplicates all strings within receiving strings list.

Exceptions:

SCTextException - strings list error detected

- (void) duplicateStringAtIndex: (SCIndex) index

Duplicates the string at the specified index.

Parameters:

index - duplicated string index

Exceptions:

SCTextException - strings list error detected

- (void) enumerate

Tells the strings list delegate object for each string in the receiving strings list.

- (void) enumerateWithDelegate: (id<SCTextDelegate>) delegate

Tells the specified delegate object for each strings in the receiving strings list.

Parameters:

delegate - delegate object

- (void) exchangeStringAtIndex:	(SCIndex)	index
withStringAtIndex:	(SCIndex)	destination

Exchanges the strings in the receiving list at given indices.

Parameters:

index	- index of the first string
destination	- index of the second string

Exceptions:

SCTextException - strings list error detected

- (NSString *) firstString

Returns the first string from the receiving strings list.

Returns:: First string

Exceptions:

SCTextException - strings list error detected

- (void) forwardMoveStringAtIndex: (SCIndex) index

Moves the string at the specified index to an one position to the top of the strings list.

Parameters:

index - moved string index

Exceptions:

SCTextException - strings list error detected

- (void) forwardMoveStringAtIndex:	(SCIndex)	index
steps:	(SCULong)	steps

Moves the string at the specified index to a given count of positions to the top of the list.

Parameters:

index	- moved string index
steps	- count of positions

Exceptions:

SCTextException - strings list error detected

- (NSArray *) foundationArray

Returns the foundation array with the copy of all receiving strings list strings.

Returns:: Foundation array with required strings

- (NSDictionary *) foundationDictionary

Returns the foundation dictionary with the copy of all receiving strings list strings.

Returns:: Foundation dictionary with required strings

- (NSSet *) foundationSet

Returns the foundation set with the copy of all receiving strings list strings.

Returns:: Foundation set with required strings

- (SCLong) freeCount

Returns the strings list free items count.

Returns:: Free items count

- (BOOL) freeItemsAvailable

Determines whether the receiving strings list have the available free space for adding items.

Returns:: YES if the strings list have the available free space, otherwise NO

- (SCIndex) indexOfLastString

Returns the index of the last string within the receiving strings list.

Returns:: Index of the last string or SCNotFound if strings list is empty

- (SCIndex) indexOfString: (NSString *) string

Returns the lowest index whose corresponding strings list item is equal to a given string.

Parameters:

string - desired string

Returns:: Index of item that equals to the specified string, otherwise SCNotFound

Exceptions:

SCTextException - strings list error detected

See also:: - indexOfString:caseInsensitive:

- (SCIndex) indexOfString:	(NSString *)	string
caseInsensitive:	(BOOL)	value

Returns the lowest index whose corresponding strings list item is equal to a given string. Case insensitively depends on the value of the specified flag.

Parameters:

string	- desired string
value	- YES for case insensitive comparison operations, otherwise NO

Returns:: Index of item that equals to the specified string, otherwise SCNotFound

Exceptions:

SCTextException - strings list error detected

See also:: - indexOfString:

- (SCIndex) indexOfString:	(NSString *)	string
fromIndex:	(SCIndex)	index

Returns the lowest index whose corresponding strings list item after the specified index is equal to a given string.

Parameters:

string	- desired string
index	- search start index

Returns:: Index of item that equals to the specified string, otherwise SCNotFound

Exceptions:

SCTextException - strings list error detected

See also:: - indexOfString:fromIndex:caseInsensitive:

- (SCIndex) indexOfString:	(NSString *)	string
fromIndex:	(SCIndex)	index
caseInsensitive:	(BOOL)	value

Returns the lowest index whose corresponding strings list item after the specified index is equal to a given string. Case insensitively depends on the value of the specified flag.

Parameters:

string	- desired string
index	- search start index
value	- YES for case insensitive comparison operations, otherwise NO

Returns:: Index of item that equals to the specified string, otherwise SCNotFound

Exceptions:

SCTextException - strings list error detected

See also:: - indexOfString:fromIndex:

- (SCIndex) indexOfSubstring: (NSString *) substring

Returns the lowest index whose corresponding list string contains a given substring.

Parameters:

substring - desired substring

Returns:: Index of string that contains the specified substring, otherwise SCNotFound

Exceptions:

SCTextException - strings list error detected

See also:: - indexOfSubstring:caseInsensitive:

- (SCIndex) indexOfSubstring:	(NSString *)	substring
caseInsensitive:	(BOOL)	value

Returns the lowest index whose corresponding list string contains a given substring. Case insensitively depends on the value of the specified flag.

Parameters:

substring	- desired substring
value	- YES for case insensitive comparison operations, otherwise NO

Returns:: Index of string that contains the specified substring, otherwise SCNotFound

Exceptions:

SCTextException - strings list error detected

See also:: - indexOfSubstring:

- (id) init

Initializes a strings list using the default settings.

Returns:: A newly initialized strings list

- (id) initWithCapacity: (SCULong) capacity

Initializes a strings list using the specified list capacity.

Parameters:

capacity - list capacity

Returns:: A newly initialized strings list

- (id) initWithCollection: (id) collection

Initializes a strings list using the speified existing collection.

Parameters:

collection - existing collection

Returns:: A newly initialized strings list

Exceptions:

SCTextException - strings list error detected

- (id) initWithDelegate: (id<SCTextDelegate>) delegate

Initializes a strings list using the specified delegate object.

Parameters:

delegate - delegate object

Returns:: A newly initialized strings list

- (id) initWithList: (SCStrings *) list

Initializes a strings list using the speified existing strings list.

Parameters:

list	- existing strings list

Returns:: A newly initialized strings list

Exceptions:

SCTextException - strings list error detected

- (id) initWithName: (NSString *) name

Initializes a strings list using the specified list name.

Parameters:

name	- list name

Returns:: A newly initialized strings list

- (id) initWithName:	(NSString *)	name
capacity:	(SCULong)	capacity

Initializes a strings list using the specified list name and capacity.

Parameters:

name	- list name
capacity	- list capacity

Returns:: A newly initialized strings list

- (id) initWithName:	(NSString *)	name
capacity:	(SCULong)	capacity
delegate:	(id<SCTextDelegate>)	delegate

Initializes a strings list using the specified list name, capacity and delegate object.

Parameters:

name	- list name
capacity	- list capacity
delegate	- delegate object

Returns:: A newly initialized strings list

- (id) initWithName:	(NSString *)	name
delegate:	(id<SCTextDelegate>)	delegate

Initializes a strings list using the specified list name and delegate object.

Parameters:

name	- list name
delegate	- delegate object

Returns:: A newly initialized strings list

- (id) initWithString: (NSString *) string

Initializes a strings list using the specified existing string.

Parameters:

string - existing string

Returns:: A newly initialized strings list

Exceptions:

SCTextException - strings list error detected

- (id) initWithStrings:	(NSString *)	string
,		...

Initializes a strings list using the specified nil terminated list of existing strings.

Parameters:

string	- first string
...	- other strings

Returns:: A newly initialized strings list

Exceptions:

SCTextException - strings list error detected

- (void) insertAtIndex:	(SCIndex)	index
strings:	(NSString *)	string
,		...

Inserts the strings from a given nil terminated list into the receiving strings list at a given index.

Parameters:

index	- index at which to insert strings
string	- fist adding string
...	- other adding strings

Exceptions:

SCTextException - strings list error detected

- (void) insertAtIndexes:	(NSIndexSet *)	indexes
strings:	(NSString *)	string
,		...

Inserts the strings from a given nil terminated list into the receiving strings list at the specified indexes.

Parameters:

indexes	- indexes at which the strings should be inserted
string	- first inserting string
...	- other inserting strings

Exceptions:

SCTextException - strings list error detected

- (void) insertLineAtIndex: (SCIndex) index

Inserts into the receiving strings list empty line at the specified index.

Parameters:

index - strings list index

Exceptions:

SCTextException - strings list error detected

- (void) insertString:	(NSString *)	string
atIndex:	(SCIndex)	index

Inserts a given string into the contents at a given index.

Parameters:

string	- inserting string
index	- index at which to insert string

Exceptions:

SCTextException - array error detected

- (void) insertStringsFromCollection:	(id)	collection
atIndex:	(SCIndex)	index

Inserts the strings from a given collection into the receiving strings list at a given index.

Parameters:

collection	- source collection
index	- index at which to insert strings

Exceptions:

SCTextException - strings list error detected

- (void) insertStringsFromCollection:	(id)	collection
atIndexes:	(NSIndexSet *)	indexes

Inserts the strings from a given collection into the receiving strings list at the specified indexes.

Parameters:

collection	- source collection
indexes	- indexes at which the strings should be inserted

Exceptions:

SCTextException - strings list error detected

- (void) insertStringsFromList:	(SCStrings *)	list
atIndex:	(SCIndex)	index

Inserts the strings from a given strings list into the receiving strings list at a given index.

Parameters:

list	- source strings list
index	- index at which to insert strings

Exceptions:

SCTextException - strings list error detected

- (void) insertStringsFromList:	(SCStrings *)	list
atIndexes:	(NSIndexSet *)	indexes

Inserts the strings from a given collection into the receiving strings list at the specified indexes.

Parameters:

list	- source strings list
indexes	- indexes at which the strings should be inserted

Exceptions:

SCTextException - strings list error detected

- (BOOL) isEmpty

Determines whether the receiving strings list is empty or contains at least one item.

Returns:: YES if the strings list is empty, otherwise NO

- (BOOL) isEqual: (id) object

Returns a boolean value that indicates whether the receiver and a given object are equal.

Parameters:

object - object to be compared to the receiver

Returns:: YES if the objects are equal, otherwise NO

Reimplemented from SCObject.

- (BOOL) isEqualToCollection: (id) collection

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

Parameters:

collection - collection with which to compare the receiving strings list

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

Exceptions:

SCTextException - strings list error detected

See also:: - isEqualToCollection:caseInsensitive:

- (BOOL) isEqualToCollection:	(id)	collection
caseInsensitive:	(BOOL)	value

Returns a boolean value that indicates whether the contens and settings of the receiving strings list are equal to the contents and settings of given collection. Case insensitively depends on the value of the specified flag.

Parameters:

collection	- collection with which to compare the receiving strings list
value	- YES for case insensitive comparison operations, otherwise NO

Returns:: YES of the contents and settings of other collection are equal to the contenst and settings of the receiving strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - isEqualToCollection:

- (BOOL) isEqualToContentsOfCollection: (id) collection

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

Parameters:

collection - collection with which to compare the receiving strings list

Returns:: YES if the contents of other collection are equal to the contents of the receiving strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - isEqualToContentsOfCollection:caseInsensitive:

- (BOOL) isEqualToContentsOfCollection:	(id)	collection
caseInsensitive:	(BOOL)	value

Returns a boolean value that indicates whether the contents of the receiving strings list are equal to the contents of given collection. Case insensitively depends on the value of the specified flag.

Parameters:

collection	- collection with which to compare the receiving strings list
value	- YES for case insensitive comparison operations, otherwise NO

Returns:: YES if the contents of other collection are equal to the contents of the receiving strings list, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - isEqualToContentsOfCollection:

- (BOOL) isEqualToContentsOfList: (SCStrings *) list

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

Parameters:

list	- strings list with which to compare the receiving strings list

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

Exceptions:

SCTextException - strings list error detected

See also:: - isEqualToContentsOfList:caseInsensitive:

- (BOOL) isEqualToContentsOfList:	(SCStrings *)	list
caseInsensitive:	(BOOL)	value

Returns a boolean value that indicates whether the contents of the receiving strings list are equal to the contents of another given strings list. Case insensitively depends on the value of the specified flag.

Parameters:

list	- strings list with which to compare the receiving strings list
value	- YES for case insensitive comparison operations, otherwise NO

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

Exceptions:

SCTextException - strings list error detected

See also:: - isEqualToContentsOfList:

- (BOOL) isEqualToList: (SCStrings *) list

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

Parameters:

list	- strings list with which to compare the receiving strings list

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

Exceptions:

SCTextException - strings list error detected

See also:: - isEqualToList:caseInsensitive:

- (BOOL) isEqualToList:	(SCStrings *)	list
caseInsensitive:	(BOOL)	value

Returns a boolean value that indicates whether the contents and settings of the receiving strings list are equal to the contents and settings of another given strings list. Case insensitively depends on the value of the specified flag.

Parameters:

list	- strings list with which to compare the receiving strings list
value	- YES for case insensitive comparison operations, otherwise NO

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

Exceptions:

SCTextException - strings list error detected

See also:: - isEqualToList:

- (BOOL) isModified

Determines whether the receiving strings list has uncommitted changes.
Note: This function is implemented only in the class SCTextFile.

Returns:: YES if the list has changes, otherwise NO

- (BOOL) isReadOnly

Determines whether the receiving strings list in read only mode.

Returns:: YES if the list is read only, otherwise NO

- (BOOL) isStrongUnique

Determines the mandatory exception generating when duplicate string detected.

Returns:: YES if exception generation required, otherwise NO

See also:: - isUnique

- (BOOL) isUnique

Determines the ability to add to the list of duplicate strings.

Returns:: NO if the addition of duplicate strings allowed, otherwise YES

See also:: - isStrongUnique

- (BOOL) isUnlimited

Determines whether the reveiving strings list have unlimited size.

Returns:: YES if the strings list is unlimited, otherwise NO

- (NSString *) lastString

Returns the last string from the receiving strings list.

Returns:: Last string

Exceptions:

SCTextException - strings list error detected

+ (SCStrings *) list

Returns a strings list created by using the default settings.

Returns:: A created strings list

Reimplemented in SCText.

+ (SCStrings *) listWithCapacity: (SCULong) capacity

Returns a strings list created by using the specified list capacity.

Parameters:

capacity - list capacity

Returns:: A created strings list

+ (SCStrings *) listWithCoder: (NSCoder *) coder

Returns a strings list created by using the specified coder.

Parameters:

coder - source coder

Returns:: A created strings list

+ (SCStrings *) listWithCollection: (id) collection

Returns a strings list created by using the specified existing collection.

Parameters:

collection - existing collection

Returns:: A created strings list

Exceptions:

SCTextException - strings list error detected

+ (SCStrings *) listWithContentsOfSerializedFile: (NSString *) path

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

Parameters:

path	- source serialized file path

Returns:: A created strings list

+ (SCStrings *) listWithDataDictionary: (NSDictionary *) dictionary

Returns a strings list created by using the specified dictionary.

Parameters:

dictionary - source dictionary

Returns:: A created strings list

+ (SCStrings *) listWithDataDictionaryFromFile: (NSString *) path

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

Parameters:

path	- source dictionary file path

Returns:: A created strings list

+ (SCStrings *) listWithDelegate: (id<SCTextDelegate>) delegate

Returns a strings list created by using the specified delegate object.

Parameters:

delegate - delegate object

Returns:: A created strings list

+ (SCStrings *) listWithFileStream: (NSString *) path

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

Parameters:

path	- stream file path

Returns:: A created strings list

Exceptions:

SCStreamException	- stream operation error detected
SCSystemException	- system error detected

+ (SCStrings *) listWithList: (SCStrings *) list

Returns a strings list created by using the specified existing strings list.

Parameters:

list	- existing strings list

Returns:: A created strings list

Exceptions:

SCTextException - strings list error detected

+ (SCStrings *) listWithName: (NSString *) name

Returns a strings list created by using the specified list name.

Parameters:

name	- list name

Returns:: A created strings list

+ (SCStrings *) listWithName:	(NSString *)	name
capacity:	(SCULong)	capacity

Returns a strings list created by using the specified list name and capacity.

Parameters:

name	- list name
capacity	- list capacity

Returns:: A created strings list

+ (SCStrings *) listWithName:	(NSString *)	name
capacity:	(SCULong)	capacity
delegate:	(id<SCTextDelegate>)	delegate

Returns a strings list created by using the specified list name, capacity and delegate object.

Parameters:

name	- list name
capacity	- list capacity
delegate	- delegate object

Returns:: A created strings list

+ (SCStrings *) listWithName:	(NSString *)	name
delegate:	(id<SCTextDelegate>)	delegate

Returns a strings list created by using the specified list name and delegate object.

Parameters:

name	- list name
delegate	- delegate object

Returns:: A created strings list

+ (SCStrings *) listWithStream: (SCStream *) stream

Returns a strings list created from the specified stream.

Parameters:

stream - stream for reading array

Returns:: A created strings list

Exceptions:

SCStreamException	- stream operation error detected
SCSystemException	- system error detected

Returns a strings list created from the specified stream.

Parameters:

stream - stream for reading strings list

Returns:: A created strings list

Exceptions:

SCStreamException	- stream operation error detected
SCSystemException	- system error detected

+ (SCStrings *) listWithString: (NSString *) string

Returns a strings list created by using the specified existing string.

Parameters:

string - existing string

Returns:: A created strings list

Exceptions:

SCTextException - strings list error detected

+ (SCStrings *) listWithStrings:	(NSString *)	string
,		...

Returns the strings list created by using the specified nil terminated list of existing strings.

Parameters:

string	- first string
...	- other strings

Returns:: A created strings list

Exceptions:

SCTextException - strings list error detected

- (void) moveStringAtIndex:	(SCIndex)	index
toIndex:	(SCIndex)	destination

Moves the string at the specified index to a given destination index.

Parameters:

index	- index of moved string
destination	- destination index

Exceptions:

SCTextException - strings list error detected

- (void) moveToFirstPositionStringAtIndex: (SCIndex) index

Moves the string at the specified index to the first position within the strings list.

Parameters:

index - moved string index

Exceptions:

SCTextException - strings list error detected

- (void) moveToLastPositionStringAtIndex: (SCIndex) index

Moves the string at the specified index to the last position within the strings list.

Parameters:

index - moved string index

Exceptions:

SCTextException - strings list error detected

- (SCQueue *) queue

Returns the queue with the copy of all receiving strings list strings.

Returns:: Queue with required strings

- (void) removeAllStrings

Removes all strings from the receving strings list.

Exceptions:

SCTextException - strings list error detected

- (void) removeDuplicatedStrings

Removes all duplicated strings.

Exceptions:

SCTextException - strings list error detected

- (void) removeFirstString

Removes from strings list the first string.

Exceptions:

SCTextException - strings list error detected

- (void) removeLastString

Removes from strings list the last string.

Exceptions:

SCTextException - strings list error detected

- (void) removeString: (NSString *) string

Removes all occurrences in the strings list of a given string.

Parameters:

string - string to remove from the strings list

Exceptions:

SCTextException - strings list error detected

See also:: - removeString:caseInsensitive:

- (void) removeString:	(NSString *)	string
caseInsensitive:	(BOOL)	value

Removes all occurrences in the strings list of a given string. Case insensitively depends on the value of the specified flag.

Parameters:

string	- string to remove from the strings list
value	- YES for the case insensitive comparison operations, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - removeString:

- (void) removeStringAtIndex: (SCIndex) index

Removes from strings list the string at the specified index.

Parameters:

index - index of the removed string

Exceptions:

SCTextException - strings list error detected

- (void) removeStrings:	(NSString *)	string
,		...

Removes all occurrences in the strings list of the strings from the specified nil terminated list.

Parameters:

string	- first string to remove from the strings list
...	- other strings to remove from the strings list

Exceptions:

SCTextException - strings list error detected

See also:: - removeWithCaseInsensitive:strings:

- (void) removeStringsAtIndexes: (NSIndexSet *) indexes

Removes from strings list the strings at the indexes from the specified index set.

Parameters:

indexes - deleted strings index set

Exceptions:

SCTextException - strings list error detected

- (void) removeStringsEqualTo: (NSString *) string

Removes from the receiving strings list objects which equal to the specified string.

Parameters:

string - template string to remove from the array

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsEqualTo:caseInsensitive:

- (void) removeStringsEqualTo:	(NSString *)	string
caseInsensitive:	(BOOL)	value

Removes from the receiving strings list objects which equal to the specified string. Case insensitively depends on the value of the specified flag.

Parameters:

string	- template string to remove from the array
value	- YES for case insensitive comparison operations, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsEqualTo:

- (void) removeStringsInCollection: (id) collection

Removes from the receiving strings list the strings in the specified collection.

Parameters:

collection - collection containing the strings to be removed from the receiving strings list

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsInCollection:caseInsensitive:

- (void) removeStringsInCollection:	(id)	collection
caseInsensitive:	(BOOL)	value

Removes from the receiving strings list the strings in the specified collection. Case insensitively depends on the value of the specified flag.

Parameters:

collection	- collection containing the strings to be removed from the receiving strings list
value	- YES for the case insensitive comparison operations, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsInCollection:

- (void) removeStringsInList: (SCStrings *) list

Removes from the receiving strings list the strings in the specified strings list.

Parameters:

list	- strings list containing the strings to be removed from the receiving strings list

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsInList:caseInsensitive:

- (void) removeStringsInList:	(SCStrings *)	list
caseInsensitive:	(BOOL)	value

Removes from the receiving strings list the strings in the specified strings list. Case insensitively depends on the value of the specified flag.

Parameters:

list	- strings list containing the strings to be removed from the receiving strings list
value	- YES for case insensitive comparison operations, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsInList:

- (void) removeStringsNotAtIndexes: (NSIndexSet *) indexes

Removes from the receiving strings list strings which not present in the specified index set.

Parameters:

indexes - index set with the keeping strings

Exceptions:

SCTextException - strings list error detected

- (void) removeStringsNotEqualTo: (NSString *) string

Removes from the receiving strings list all strings which not equal to the specified string.

Parameters:

string - template strings

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsNotEqualTo:caseInsensitive:

- (void) removeStringsNotEqualTo:	(NSString *)	string
caseInsensitive:	(BOOL)	value

Removes from the receiving strings list all strings which not equal to the specified string. Case insensitively depends on the value of the specified flag.

Parameters:

string	- template strings
value	- YES for the case insensitive comparison operations, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsNotEqualTo:

- (void) removeStringsNotInCollection: (id) collection

Removes from the receiving strings list all strings which not present in the specified collection.

Parameters:

collection - strings collection

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsNotInCollection:caseInsensitive:

- (void) removeStringsNotInCollection:	(id)	collection
caseInsensitive:	(BOOL)	value

Removes from the receiving strings list all strings which not present in the specified collection. Case insensitively depends on the value of the specified flag.

Parameters:

collection	- strings collection
value	- YES for the case insensitive comparison operations, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsNotInCollection:

- (void) removeStringsNotInList: (SCStrings *) list

Removes from the receiving strings list all strings which not present in the specified strings list.

Parameters:

list	- strings list

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsNotInList:caseInsensitive:

- (void) removeStringsNotInList:	(SCStrings *)	list
caseInsensitive:	(BOOL)	value

Removes from the receiving strings list all strings which not present in the specified strings list. Case insensitively depends on the value of the specified flag.

Parameters:

list	- strings list
value	- YES for the case insensitive comparison operations, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsNotInList:

- (void) removeStringsWithoutSubstring: (NSString *) substring

Removes all occurrences in the strings list of the strings which not contain the specified substring.

Parameters:

substring - keeping substring

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsWithoutSubstring:caseInsensitive:

- (void) removeStringsWithoutSubstring:	(NSString *)	substring
caseInsensitive:	(BOOL)	value

Removes all occurrences in the strings list of the strings which not contain the specified substring. Case insensitively depends on the value of the specified flag.

Parameters:

substring	- keeping substring
value	- YES for the case insensitive comparison operations, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsWithoutSubstring:

- (void) removeStringsWithSubstring: (NSString *) substring

Removes all occurrences in the strings list of the strings which contain the specified substring.

Parameters:

substring - removing substring

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsWithSubstring:caseInsensitive:

- (void) removeStringsWithSubstring:	(NSString *)	substring
caseInsensitive:	(BOOL)	value

Removes all occurrences in the strings list of the strings which contain the specified substring. Case insensitively depends on the value of the specified flag.

Parameters:

substring	- removing substring
value	- YES for the case insensitive comparison operations, otherwise NO

Exceptions:

SCTextException - strings list error detected

See also:: - removeStringsWithSubstring:

- (void) removeWithCaseInsensitive:	(BOOL)	value
strings:	(NSString *)	string
,		...

Removes all occurrences in the strings list of the strings from the specified nil terminated list. Case insensitively depends on the value of the specified flag.

Parameters:

value	- YES for case insensitive comparison operations, otherwise NO
string	- first string to remove from the strings list
...	- other strings to remove from the strings list

Exceptions:

SCTextException - strings list error detected

See also:: - removeStrings:

- (void) replaceStringAtIndex:	(SCIndex)	index
withString:	(NSString *)	string

Replaces the string at the specified index with a given string.

Parameters:

index	- index of the string to be replaced
string	- string with which to replace the string at the specified index

Exceptions:

SCTextException - strings list error detected

- (void) replaceStringsAtIndexes:	(NSIndexSet *)	indexes
withStrings:	(NSString *)	string
,		...

Replaces the strings in the receiving list at specified locations with the strings from a given nil terminated list.

Parameters:

indexes	- indexes of strings to be replaced
string	- first string from list of strings to replace strings in the receiving list
...	- other strings from list of strings to replace strings in the receiving list

Exceptions:

SCTextException - strings list error detected

- (void) replaceStringsAtIndexes:	(NSIndexSet *)	indexes
withStringsFromCollection:	(id)	collection

Replaces the strings in the receiving strings list at specified locations with the strings from a given collection.

Parameters:

indexes	- indexes of strings to be replaced
collection	- strings with which to replace the strings in the receiving strings list

Exceptions:

SCTextException - strings list error detected

- (void) replaceStringsAtIndexes:	(NSIndexSet *)	indexes
withStringsFromList:	(SCStrings *)	list

Replaces the strings in the receiving list at specified locations with the strings from a given strings list.

Parameters:

indexes	- indexes of strings to be replaced
list	- strings with which to replace the strings in the receiving list

Exceptions:

SCTextException - strings list error detected

- (void) reverse

Reverses the order of all strings in the receiving array.

Exceptions:

SCTextException - strings list error detected

- (SCStrings *) reversedList

Returns the strings list with the all strings from the receiving strings list in reverse order.

Returns:: Strings list with the strings in reverse order

- (void) reverseEnumerate

Tells the strings list delegate object for each string in the receiving strings list, in reverse order.

- (void) reverseEnumerateWithDelegate: (id<SCTextDelegate>) delegate

Tells the specified delegate object for each strings in the receiving strings list, in reverse order.

Parameters:

delegate - delegate object

- (NSEnumerator *) reverseStringEnumerator

Returns an enumerator object that lets you access each string in the strings list, in reverse order.

Returns:: Enumerator object

- (SCSet *) set

Returns the set with the copy of all receiving strings list strings.

Returns:: Set with required strings

- (void) setCapacity: (SCULong) capacity

Sets the capacity of the receiving strings list.

Parameters:

capacity - list capacity

- (void) setCaseInsensitive: (BOOL) value

Sets the case insensitive flag value.

Parameters:

value - YES for case insensitive operations, otherwise NO

- (void) setDelegate: (id<SCTextDelegate>) delegate

Sets the delegate object of the receiving strings list.

Parameters:

delegate - delegate object

- (void) setReadOnly: (BOOL) flag

Sets the receiving strings list read only mode flag.

Parameters:

flag	- YES for set read only mode, otherwise NO

- (void) setStrongUnique: (BOOL) flag

Sets the duplicate string exception generation flag.

Parameters:

flag	- YES for generate exception, NO for ignoring string duplicating

- (void) setTextName: (NSString *) name

Sets the name of the receiving strings list.

Parameters:

name	- list name

- (void) setUnique: (BOOL) flag

Sets the strings list unique flag value.

Parameters:

flag	- NO to permit strings duplicating, otherwise YES

- (SCStrings *) sortedList

Returns the strings list with ascending sorted using the default algorithm strings from the receving strings list.

Returns:: Strings list with sorted strings

Exceptions:

SCTextException - strings list error detected

- (SCStrings *) sortedListAscending

Returns the strings list with ascending sorted using the default algorithm strings from the receving strings list.

Returns:: Strings list with sorted strings

Exceptions:

SCTextException - strings list error detected

- (SCStrings *) sortedListAscendingWithMethod: (id<SCSortingProtocol>) method

Returns the strings list with ascending sorted using the specified algorithm strings from the receving strings list.

Parameters:

method - sorting algorithm

Returns:: Strings list with sorted strings

Exceptions:

SCTextException - strings list error detected

- (SCStrings *) sortedListDescending

Returns the strings list with descending sorted using the default algorithm strings from the receving strings list.

Returns:: Strings list with sorted strings

Exceptions:

SCTextException - strings list error detected

- (SCStrings *) sortedListDescendingWithMethod: (id<SCSortingProtocol>) method

Returns the strings list with descending sorted using the specified algorithm strings from the receving strings list.

Parameters:

method - sorting algorithm

Returns:: Strings list with sorted strings

Exceptions:

SCTextException - strings list error detected

- (SCStrings *) sortedListWithMethod: (id<SCSortingProtocol>) method

Returns the strings list with ascending sorted using the specified algorithm strings from the receving strings list.

Parameters:

method - sorting algorithm

Returns:: Strings list with sorted strings

Exceptions:

SCTextException - strings list error detected

- (void) sortingList

Sort ascending the receiving strings list using the default sorting algorithm.

Exceptions:

SCTextException - strings list error detected

- (void) sortingListAscending

Sort ascending the receiving strings list using the default sorting algorithm.

Exceptions:

SCTextException - strings list error detected

- (void) sortingListAscendingWithMethod: (id<SCSortingProtocol>) method

Sort ascending the receiving strings list using the specified sorting algorithm.

Parameters:

method - sorting algoritm

Exceptions:

SCTextException - strings list error detected

- (void) sortingListDescending

Sort descending the receiving strings list using the default sorting algorithm.

Exceptions:

SCTextException - strings list error detected

- (void) sortingListDescendingWithMethod: (id<SCSortingProtocol>) method

Sort descending the receiving strings list using the specified sorting algorithm.

Parameters:

method - sorting algoritm

Exceptions:

SCTextException - strings list error detected

- (void) sortingListWithMethod: (id<SCSortingProtocol>) method

Sort ascending the receiving strings list using the specified sorting algorithm.

Parameters:

method - sorting algoritm

Exceptions:

SCTextException - strings list error detected

- (SCStack *) stack

Returns the stack with the copy of all receiving strings list strings.

Returns:: Stack with required strings

- (NSString *) stringAtIndex: (SCIndex) index

Returns the string located at the specified index.

Parameters:

index - required string index

Returns:: String at the specified index

Exceptions:

SCTextException - incorrect index detected

- (NSEnumerator *) stringEnumerator

Returns an enumerator object that lets you access each string in the strings list.

Returns:: Enumerator object

- (SCStrings *) stringsAtIndexes: (NSIndexSet *) indexes

Returns a strings list containing the strings in the receiving list at the indexes specified by a given index set.

Parameters:

indexes - index set

Returns:: Strings list with the required strings

Exceptions:

SCTextException - strings list error detected

- (SCStrings *) stringsWithoutSubstring: (NSString *) substring

Returns a list of strings that do not contain the specified substring.

Parameters:

substring - desired substring

Returns:: Strings list with required strings

See also:: - stringsWithoutSubstring:caseInsensitive:

- (SCStrings *) stringsWithoutSubstring:	(NSString *)	substring
caseInsensitive:	(BOOL)	value

Returns a list of strings that do not contain the specified substring. Case insensitively depends on the value of the specified flag.

Parameters:

substring	- desired substring
value	- YES for case insensitive comparison operations, otherwise NO

Returns:: Strings list with required strings

See also:: - stringsWithoutSubstring:

- (SCStrings *) stringsWithSubstring: (NSString *) substring

Returns a list of strings that contain the specified substring.

Parameters:

substring - desired substring

Returns:: Strings list with required strings

See also:: - stringsWithSubstring:caseInsensitive:

- (SCStrings *) stringsWithSubstring:	(NSString *)	substring
caseInsensitive:	(BOOL)	value

Returns a list of strings that contain the specified substring. Case insensitively depends on the value of the specified flag.

Parameters:

substring	- desired substring
value	- YES for case insensitive comparison operations, otherwise NO

Returns:: Strings list with required strings

See also:: - stringsWithSubstring:

- (NSString *) textName

Returns a name of the receiving strings list.

Returns:: List name

- (SCUnidirectionalList *) unidirectionalList

Returns the unidirectional list with the copy of all receiving strings list strings.

Returns:: Unidirectional list with required strings

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

SCStrings.h
SCStrings.m

SCStrings Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation