Strings list class. More...

#import <SCStrings.h>

Inheritance diagram for SCStrings:

Instance Properties
NSString *	name

BOOL	readOnly

BOOL	caseInsensitive

id< SCTextDelegate >	delegate

SCULong	count

BOOL	empty

NSString *	description

BOOL	modified

Creating Strings Lists
(SCStrings *)	+ stringsWithCoder:

(SCStrings *)	+ stringsWithContentsOfSerializedFile:

(SCStrings *)	+ stringsWithDataDictionary:

(SCStrings *)	+ stringsWithDataDictionaryFromFile:

(SCStrings *)	+ stringsWithStream:

(SCStrings *)	+ stringsWithFileStream:

(SCStrings *)	+ stringsWithName:

(SCStrings *)	+ stringsWithString:

(SCStrings *)	+ stringsWithCollection:

(SCStrings *)	+ stringsWithStrings:

(SCStrings *)	+ strings

Initializing Strings Lists
(id)	- initWithName:

(id)	- initWithString:

(id)	- initWithCollection:

(id)	- initWithStrings:

(id)	- init

Copying Strings Lists
(void)	- setStrings:

(void)	- setCollection:

(void)	- setString:

Comparing Strings Lists
(BOOL)	- isEqualToStrings:

(BOOL)	- isEqualToCollection:

(BOOL)	- isEqualTo:

(BOOL)	- isEqual:

Strings Enumerators
NSEnumerator *	stringEnumerator

NSEnumerator *	reverseStringEnumerator

(void)	- enumerateWithDelegate:

(void)	- enumerate

(void)	- reverseEnumerateWithDelegate:

(void)	- reverseEnumerate

Converting Strings Lists
SCArray *	array

NSArray *	foundationArray

Sorting Strings Lists
SCStrings *	sortedStrings

(void)	- sortAscendingWithSorter:

(void)	- sortDescendingWithSorter:

(void)	- sortWithSorter:

(void)	- sortAscending

(void)	- sortDescending

(void)	- sort

(SCStrings *)	- ascendingSortedStringsWithSorter:

(SCStrings *)	- descendingSortedStringsWithSorter:

(SCStrings *)	- sortedStringsWithSorter:

(SCStrings *)	- ascendingSortedStrings

(SCStrings *)	- descendingSortedStrings

Adding Strings
(void)	- addString:

(void)	- addCollection:

(void)	- addStrings:

(void)	- addLine

(void)	- insertString:atIndex:

(void)	- insertStrings:atIndex:

(void)	- insertCollection:atIndex:

(void)	- insertStrings:atIndexes:

(void)	- insertCollection:atIndexes:

(void)	- insertLineAtIndex:

Removing Strings
(void)	- removeAllStrings

(void)	- removeFirstString

(void)	- removeLastString

(void)	- removeStringAtIndex:

(void)	- removeStringsAtIndexes:

(void)	- removeString:

(void)	- removeStrings:

(void)	- removeCollection:

(void)	- removeStringsWithSubstring:

(void)	- removeStringsNotAtIndexes:

(void)	- removeStringsNotEqualTo:

(void)	- removeStringsNotInStrings:

(void)	- removeStringsNotInCollection:

(void)	- removeStringsWithoutSubstring:

(void)	- removeDuplicatedStrings

Replacing Strings
(void)	- replaceStringAtIndex:withString:

(void)	- replaceStringsAtIndexes:withStrings:

(void)	- replaceStringsAtIndexes:withCollection:

(void)	- replaceString:withString:

Copying and Moving Strings
SCStrings *	reversedStrings

(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

Querying a Strings List
NSString *	firstString

NSString *	lastString

(NSString *)	- stringAtIndex:

(SCStrings *)	- stringsAtIndexes:

Finding Strings in a Strings List
SCIndex	indexOfLastString

(BOOL)	- containsString:

(BOOL)	- containsStrings:

(BOOL)	- containsCollection:

(BOOL)	- containsAnyString:

(BOOL)	- containsAnyStringFromCollection:

(BOOL)	- containsSubstring:

(BOOL)	- containsSubstrings:

(BOOL)	- containsSubstringsFromCollection:

(BOOL)	- containsAnySubstring:

(BOOL)	- containsAnySubstringFromCollection:

(BOOL)	- containsDuplicatedStrings

(SCIndex)	- indexOfString:

(SCIndex)	- indexOfSubstring:

(SCStrings *)	- stringsWithSubstring:

(SCStrings *)	- stringsWithSubstrings:

(SCStrings *)	- stringsWithSubstringsFromCollection:

(SCStrings *)	- stringsWithAnySubstring:

(SCStrings *)	- stringsWithAnySubstringFromCollection:

(SCStrings *)	- stringsWithoutSubstring:

(SCStrings *)	- stringsWithoutSubstrings:

(SCStrings *)	- stringsWithoutSubstringsFromCollection:

(SCULong)	- countOfString:

(SCULong)	- countOfSubstring:

(SCULong)	- countOfStringsWithSubstring:

Additional Inherited Members
Instance Methods inherited from SCObject
(id)	- initWithContentsOfSerializedFile:

(BOOL)	- writeContentsToSerializedFile:

(id)	- initWithDataDictionaryFromFile:

(void)	- writeToDataDictionaryFile:atomically:

(void)	- writeToDataDictionaryFile:

(NSDictionary *)	- dataDictionary

(id)	- initWithFileStream:

(void)	- writeToFileStream:

(void)	- appendToFileStream:

Instance Methods inherited from <SCCoding>
Instance Methods inherited from <SCDictionaring>
Instance Methods inherited from <SCCollectioning>

Detailed Description

Strings list class.

Since: version 1.1.4

Implements the strings list, which stores the strings and allows the simple strings operations. Also class is a parent class for all other text classes.
Class instances can thrown the following exceptions:

Method Documentation

- (void) addCollection: (id) collection

Adds into the receiving strings list the strings from the specified existing collection of any supported type.

Parameters

collection - existing collection of any supported type

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

- (void) addLine

Adds into the receiving strings list the empty string. Empty string is a string, which does not contains any characters.

Exceptions

SCTextException - text error detected

- (void) addString: (NSString *) string

Adds into the receiving strings list the specified existing string.

Parameters

string - added existing string

Exceptions

SCTextException - text error detected

- (void) addStrings: (SCStrings *) strings

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

Parameters

strings - existing strings list

Exceptions

SCTextException - text error detected

- (SCStrings *) ascendingSortedStrings

Returns the strings list with ascending sorted strings from the receiving strings list.

Returns: Strings list with sorted strings

Exceptions

SCTextException - text error detected

See also: sortedStrings

- (SCStrings *) ascendingSortedStringsWithSorter: (id<SCSorter>) sorter

Returns the strings list with ascending sorted using the specified strings sorter strings from the receiving strings list.

Parameters

sorter - strings sorter

Returns: Strings list with sorted strings

Exceptions

SCTextException - text error detected

See also: - sortedStringsWithSorter:

- (void) backwardMoveStringAtIndex: (SCIndex) index

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

Parameters

index - moved string index

Exceptions

SCTextException - text error detected

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

Moves the string at the specified index to a given number of positions to the bottom of the receiving strings list.

Parameters

index	- moved string index
steps	- number of positions

Exceptions

SCTextException - text error detected

- (BOOL) containsAnyString: (SCStrings *) strings

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

Parameters

strings - required strings list

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

- (BOOL) containsAnyStringFromCollection: (id) collection

Returns a boolean value that indicates whether the receiving strings list contains at least one string from the specified collection of any supported type.

Parameters

collection - source collection

Returns: YES if at least one of strings within the collection is present in the receiving strings list, otherwise NO

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

- (BOOL) containsAnySubstring: (SCStrings *) substrings

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

Parameters

substrings - strings list with desired substrings

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

- (BOOL) containsAnySubstringFromCollection: (id) collection

Returns a boolean value that indicates whether the receiving strings list contains at least one substring from the specified collection of any supported type.

Parameters

collection - collection with desired strings

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

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

- (BOOL) containsCollection: (id) collection

Returns a boolean value that indicates whether the receiving strings list contains the all strings from the specified collection of any supported type.

Parameters

collection - collection with the requited strings

Returns: YES if all of strings from the specified collection are present in the receiving strings list, otherwise NO

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

- (BOOL) containsDuplicatedStrings

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

Returns: YES if the receiving 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 receiving strings list, otherwise NO

- (BOOL) containsStrings: (SCStrings *) strings

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

Parameters

strings - required strings list

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

- (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 presents in the receiving strings list, otherwise NO

- (BOOL) containsSubstrings: (SCStrings *) substrings

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

Parameters

substrings - strings list with the desired substrings

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

- (BOOL) containsSubstringsFromCollection: (id) collection

Returns a boolean value that indicates whether the receiving strings list contains all of substrings from the specified collection of any supported type.

Parameters

collection - collection with the desired substrings

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

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection 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 - text error detected

- (SCULong) countOfString: (NSString *) string

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

Parameters

string - desired string

Returns: Count of desired strings

- (SCULong) countOfStringsWithSubstring: (NSString *) substring

Returns a count of strings from the receiving strings list that contain at least one occurrence of the specified substring.

Parameters

substring - requited substring

Returns: Count of strings with the desired substring

- (SCULong) countOfSubstring: (NSString *) substring

Returns a count of occurrences the specified substring into the strings within the receiving strings list.

Parameters

substring - desired substring

Returns: Count of accurrences of the desired substring

- (SCStrings *) descendingSortedStrings

Returns the strings list with descending sorted strings from the receiving strings list.

Returns: Strings list with sorted strings

Exceptions

SCTextException - text error detected

- (SCStrings *) descendingSortedStringsWithSorter: (id<SCSorter>) sorter

Returns the strings list with descending sorted using the specified strings sorter strings from the receiving strings list.

Parameters

sorter - strings sorter

Returns: Strings list with sorted strings

Exceptions

SCTextException - text error detected

- (void) duplicate

Duplicates content of the receiving strings list.

Exceptions

SCTextException - text error detected

- (void) duplicateAllStrings

Duplicates all strings within receiving strings list.

Exceptions

SCTextException - text error detected

- (void) duplicateStringAtIndex: (SCIndex) index

Duplicates the string at the specified index.

Parameters

index - duplicated string index

Exceptions

SCTextException - text 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 string in the receiving strings list.

Parameters

delegate - delegate object

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

Exchanges the strings in the receiving strings list at a given indexes.

Parameters

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

Exceptions

SCTextException - text error detected

- (void) forwardMoveStringAtIndex: (SCIndex) index

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

Parameters

index - moved string index

Exceptions

SCTextException - text error detected

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

Moves the string at the specified index to a given number of positions to the top of the receiving strings list.

Parameters

index	- moved string index
steps	- number of positions

Exceptions

SCTextException - text error detected

- (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 - text error detected

- (SCIndex) indexOfSubstring: (NSString *) substring

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

Parameters

substring - desired substring

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

- (id) init

Initializes an empty unnamed strings list using the default settings.

Returns: A newly initialized strings list

- (id) initWithCollection: (id) collection

Initializes a strings list using strings from the specified existing source collection of any supported type.

Parameters

collection - existing source collection of any supported type

Returns: A newly initialized strings list

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

- (id) initWithName: (NSString *) name

Initializes a strings list using the specified list name.

Attention: Designed initializer

Parameters

name	- list name

Returns: A newly initialized strings list

- (id) initWithString: (NSString *) string

Initializes a strings list using the specified existing source string.

Parameters

string - existing source string

Returns: A newly initialized strings list

Exceptions

SCTextException - text error detected

- (id) initWithStrings: (SCStrings *) strings

Initializes a strings list using strings from the specified existing source strings list.

Attention: Designed initializator

Parameters

strings - existing source strings list

Returns: A newly initialized strings list

Exceptions

SCTextException - text error detected

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

Inserts the strings from the specified existing collection of any supported type into the receiving strings list at a given index.

Parameters

collection	- existing collection of any supported type
index	- index at which to insert strings

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

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

Inserts the strings from the specified existing collection of any supported type at the specified indexes into the receiving strings list.

Parameters

collection	- existing collection of any supported type
indexes	- indexes at which the strings should be inserted

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

- (void) insertLineAtIndex: (SCIndex) index

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

Parameters

index - strings list index

Exceptions

SCTextException - text error detected

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

Inserts a given existing string into the receiving strings list at a given index.

Parameters

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

Exceptions

SCTextException - text error detected

- (void) insertStrings:	(SCStrings *)	strings
atIndex:	(SCIndex)	index

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

Parameters

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

Exceptions

SCTextException - text error detected

- (void) insertStrings:	(SCStrings *)	strings
atIndexes:	(NSIndexSet *)	indexes

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

Parameters

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

Exceptions

SCTextException - text error detected

- (BOOL) isEqual: (id) object

Returns a boolean value that indicates whether the content of the receiving strings list is equal to the specified object.

Parameters

object - object with which to compare the receiving strings list

Returns: YES if the specified object is equal to the content of the receiving strings list, otherwise NO

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

See also: - isEqualTo:

Reimplemented from SCObject.

- (BOOL) isEqualTo: (id) object

Returns a boolean value that indicates whether the content of the receiving strings list is equal to the specified object.

Parameters

object - object with which to compare the receiving strings list

Returns: YES if the specified object is equal to the content of the receiving strings list, otherwise NO

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

See also: - isEqual:

- (BOOL) isEqualToCollection: (id) collection

Returns a boolean value that indicates whether the content of the receiving strings list is equal to the content of the specified collection of any supported type.

Parameters

collection - collection with which to compare the receiving strings list

Returns: YES if the content of the specified collection is equal to the content of the receiving strings list, otherwise NO

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

- (BOOL) isEqualToStrings: (SCStrings *) strings

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

Parameters

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

Returns: YES if the content of other strings list is equal to the content of the receiving strings list, otherwise NO

- (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 - text error detected

- (void) moveToFirstPositionStringAtIndex: (SCIndex) index

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

Parameters

index - moved string index

Exceptions

SCTextException - text error detected

- (void) moveToLastPositionStringAtIndex: (SCIndex) index

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

Parameters

index - moved string index

Exceptions

SCTextException - text error detected

- (void) removeAllStrings

Removes all strings from the receiving strings list.

Exceptions

SCTextException - text error detected

- (void) removeCollection: (id) collection

Removes from the receiving strings list the strings from the specified collection of any supported type.

Parameters

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

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

- (void) removeDuplicatedStrings

Removes all duplicates strings from the receiving strings list.

Exceptions

SCTextException - text error detected

- (void) removeFirstString

Removes the first string from the receiving strings list.

Exceptions

SCTextException - text error detected

- (void) removeLastString

Removes the last string from the receiving strings list.

Exceptions

SCTextException - text error detected

- (void) removeString: (NSString *) string

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

Parameters

string - string to remove from the strings list

Exceptions

SCTextException - text error detected

- (void) removeStringAtIndex: (SCIndex) index

Removes from the receiving strings list the string at the specified index.

Parameters

index - index of the removed string

Exceptions

SCTextException - text error detected

- (void) removeStrings: (SCStrings *) strings

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

Parameters

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

Exceptions

SCTextException - text error detected

- (void) removeStringsAtIndexes: (NSIndexSet *) indexes

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

Parameters

indexes - deleted strings index set

Exceptions

SCTextException - text error detected

- (void) removeStringsNotAtIndexes: (NSIndexSet *) indexes

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

Parameters

indexes - index set with the keeping strings

Exceptions

SCTextException - text error detected

- (void) removeStringsNotEqualTo: (NSString *) string

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

Parameters

string - keeping string

Exceptions

SCTextException - text error detected

- (void) removeStringsNotInCollection: (id) collection

Removes from the receiving strings list all strings which not present in the specified collection of any supported type.

Parameters

collection - collection with keeped strings

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

- (void) removeStringsNotInStrings: (SCStrings *) strings

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

Parameters

strings - keeping strings list

Exceptions

SCTextException - text error detected

- (void) removeStringsWithoutSubstring: (NSString *) substring

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

Parameters

substring - keeping substring

Exceptions

SCTextException - text error detected

- (void) removeStringsWithSubstring: (NSString *) substring

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

Parameters

substring - removing substring

Exceptions

SCTextException - text error detected

- (void) replaceString:	(NSString *)	string
withString:	(NSString *)	newString

Replaces all occurrences of the specified strings within the receiving strings list with a given string.

Parameters

string	- replaced string
newString	- replacement string

Exceptions

SCTextException - text error detected

- (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 - text error detected

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

Replaces the strings in the receiving list at specified locations with the strings from the specified collection of any supported type.

Parameters

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

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

- (void) replaceStringsAtIndexes:	(NSIndexSet *)	indexes
withStrings:	(SCStrings *)	strings

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

Parameters

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

Exceptions

SCTextException - text error detected

- (void) reverse

Reverses the order of all strings in the receiving strings list.

Exceptions

SCTextException - text error detected

- (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 string in the receiving strings list, in reverse order.

Parameters

delegate - delegate object

- (void) setCollection: (id) collection

Replaces the content and settings of the receiving strings list by using the content and settings from the specified existing source collection of any supported type.

Parameters

collection - existing source collection of any supported type

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

- (void) setString: (NSString *) string

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

Parameters

string - existing source string

Exceptions

SCTextException - text error detected

- (void) setStrings: (SCStrings *) strings

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

Parameters

strings - existing source strings list

Exceptions

SCTextException - text error detected

- (void) sort

Sorts ascending the receiving strings list using the defult strings sorter.

Exceptions

SCTextException - text error detected

See also: - sortAscending

- (void) sortAscending

Sorts ascending the receiving strings list using the default strings sorter.

Exceptions

SCTextException - text error detected

See also: - sort

- (void) sortAscendingWithSorter: (id<SCSorter>) sorter

Sorts ascending the receiving strings list using the specified strings sorter.

Parameters

sorter - strings sorter

Exceptions

SCTextException - text error detected

See also: - sortWithSorter:

- (void) sortDescending

Sorts descending the receiving strings list using the default strings sorter.

Exceptions

SCTextException - text error detected

- (void) sortDescendingWithSorter: (id<SCSorter>) sorter

Sorts descending the receiving strings list using the specified strings sorter.

Parameters

sorter - strings sorter

Exceptions

SCTextException - text error detected

- (SCStrings *) sortedStringsWithSorter: (id<SCSorter>) sorter

Returns the strings list with ascending sorted using the specified strings sorter strings from the receiving strings list.

Parameters

sorter - strings sorter

Returns: Strings list with sorted strings

Exceptions

SCTextException - text error detected

See also: - ascendingSortedStringsWithSorter:

- (void) sortWithSorter: (id<SCSorter>) sorter

Sorts ascending the receiving strings list using the specified strings sorter.

Parameters

sorter - strings sorter

Exceptions

SCTextException - text error detected

See also: - sortAscendingWithSorter:

- (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 - text error detected

+ (SCStrings *) strings

Returns an empty unnamed strings list created by using the default settings.

Returns: A created strings list

- (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 with the indexes of the required strings

Returns: Strings list with the required strings

Exceptions

SCTextException - text error detected

- (SCStrings *) stringsWithAnySubstring: (SCStrings *) substrings

Returns a list of strings that contain at least one substring from the specified list.

Parameters

substrings - desired strings list

Returns: Strings list with required strings

- (SCStrings *) stringsWithAnySubstringFromCollection: (id) collection

Returns a list of strings that contain at least one substring from the specified collection of any supported type.

Parameters

collection - collection with desired substrings

Returns: Strings list with required strings

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

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

Returns a strings list created by using the specified coder.

Parameters

coder - source coder

Returns: A created strings list

+ (SCStrings *) stringsWithCollection: (id) collection

Returns a strings list created by using strings from the specified existing collection of any supported type.

Parameters

collection - existing source collection of any supported type

Returns: A created strings list

Exceptions

SCTextException	- text error detected
SCTextException	- collection error detected

+ (SCStrings *) stringsWithContentsOfSerializedFile: (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 *) stringsWithDataDictionary: (NSDictionary *) dictionary

Returns a strings list created by using the specified data dictionary.

Parameters

dictionary - source data dictionary

Returns: A created strings list

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

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

Parameters

path	- source data dictionary file path

Returns: A created strings list

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

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

Parameters

path	- source stream file path

Returns: A created strings list

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

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

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

Parameters

name	- list name

Returns: A created strings list

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

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

Parameters

substring - desired substring

Returns: List of strings without specified substring

- (SCStrings *) stringsWithoutSubstrings: (SCStrings *) substrings

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

Parameters

substrings - desired substrings list

Returns: List of strings without specified substrings

- (SCStrings *) stringsWithoutSubstringsFromCollection: (id) collection

Returns a list of strings that do not contain the substrings from the specified collection of any supported type.

Parameters

collection - collection with desired substrings

Returns: List of strings without specified substrings

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

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

Returns a strings list created by using the data from the specified stream.

Parameters

stream - source stream

Returns: A created strings list

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

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

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

Parameters

string - existing source string

Returns: A created strings list

Exceptions

SCTextException - text error detected

+ (SCStrings *) stringsWithStrings: (SCStrings *) strings

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

Parameters

strings - existing source strings list

Returns: A created strings list

Exceptions

SCTextException - text error detected

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

Returns a list of strings that contain the specified substring.

Parameters

substring - desired substring

Returns: Strings list with required strings

- (SCStrings *) stringsWithSubstrings: (SCStrings *) substrings

Returns a list of strings that contain all substrings from the specified list.

Parameters

substrings - desired strings list

Returns: Strings list with required strings

- (SCStrings *) stringsWithSubstringsFromCollection: (id) collection

Returns a list of strings that contain all substrings from the specified collection of any supported type.

Parameters

collection - collection with desired substrings

Returns: Strings list with required strings

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

Property Documentation

- (SCArray *) array

readnonatomicretain

Returns an array with the copy of all receving strings list strings.

- (BOOL) caseInsensitive

readwritenonatomicassign

Determines whether the search and comparison operations are case insensitive.

- (SCULong) count

readnonatomicassign

Returns the count of strings within the strings list.

- (id< SCTextDelegate >) delegate

readwritenonatomicretain

Contains the strings list delegate object.

- (NSString *) description

readnonatomicretain

Returns the receiving strings list description.

- (BOOL) empty

readnonatomicassign

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

- (NSString *) firstString

readnonatomicretain

Returns the first string from the receiving strings list.

- (NSArray *) foundationArray

readnonatomicretain

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

- (SCIndex) indexOfLastString

readnonatomicassign

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

- (NSString *) lastString

readnonatomicretain

Returns the last string from the receivinf strings list.

- (BOOL) modified

readnonatomicassign

Determines whether the receiving strings list has uncommitted changes.

- (NSString *) name

readwritenonatomicretain

Contains the text instance name.

- (BOOL) readOnly

readwritenonatomicassign

Determines whether the strings list in read only mode.

- (SCStrings *) reversedStrings

readnonatomicretain

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

- (NSEnumerator *) reverseStringEnumerator

readnonatomicretain

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

- (SCStrings *) sortedStrings

readnonatomicretain

Returns the strings list with ascending sorted strings from the receiving strings list.

- (NSEnumerator *) stringEnumerator

readnonatomicretain

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

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

SCStrings.h
SCStrings.m

Instance Properties

Creating Strings Lists

Initializing Strings Lists

Copying Strings Lists

Comparing Strings Lists

Strings Enumerators

Converting Strings Lists

Sorting Strings Lists

Adding Strings

Removing Strings

Replacing Strings

Copying and Moving Strings

Querying a Strings List

Finding Strings in a Strings List

Additional Inherited Members

Detailed Description

Method Documentation

Property Documentation