Unique strings list class. More...

#import <SCUniqueStrings.h>

Inheritance diagram for SCUniqueStrings:

Instance Properties
BOOL	strongMode

Creating Unique Strings Lists
(instancetype)	+ uniqueStringsWithCoder:

(instancetype)	+ uniqueStringsWithContentsOfSerializedFile:

(instancetype)	+ uniqueStringsWithDataDictionary:

(instancetype)	+ uniqueStringsWithDataDictionaryFromFile:

(instancetype)	+ uniqueStringsWithStream:

(instancetype)	+ uniqueStringsWithFileStream:

(instancetype)	+ uniqueStringsWithData:

(instancetype)	+ uniqueStringsWithContentsOfFile:

(instancetype)	+ uniqueStringsWithContentsOfURL:

(instancetype)	+ uniqueStringsWithContentsOfURLString:

(instancetype)	+ uniqueStringsWithName:

(instancetype)	+ uniqueStringsWithString:

(instancetype)	+ uniqueStringsWithCollection:

(instancetype)	+ uniqueStringsWithArray:

(instancetype)	+ uniqueStringsWithStrings:

(instancetype)	+ uniqueStringsWithUniqueStrings:

(instancetype)	+ uniqueStrings

Initializing Unique Strings Lists
(instancetype)	- initWithUniqueStrings:

Copying Unique Strings Lists
(void)	- setUniqueStrings:

Comparing Unique Strings Lists
(BOOL)	- isEqualToUniqueStrings:

Converting Unique Strings Lists
SCStrings *	strings

SCOrderedSet *	orderedSet

NSOrderedSet *	foundationOrderedSet

Deriving New Unique Strings Lists
(instancetype)	- uniqueStringsByAddingString:

(instancetype)	- uniqueStringsByAddingCollection:

(instancetype)	- uniqueStringsByAddingStringsFromArray:

(instancetype)	- uniqueStringsByAddingArray:

(instancetype)	- uniqueStringsByAddingStrings:

(instancetype)	- uniqueStringsByAddingUniqueStrings:

Additional Inherited Members
Instance Methods inherited from SCStrings
(instancetype)	- initWithString:

(instancetype)	- initWithCollection:

(instancetype)	- initWithArray:

(instancetype)	- init

(void)	- setStrings:

(void)	- setCollection:

(void)	- setString:

(BOOL)	- isEqualToStrings:

(BOOL)	- isEqualToCollection:

(BOOL)	- isEqualTo:

(BOOL)	- isEqual:

(instancetype)	- stringsByAddingString:

(instancetype)	- stringsByAddingCollection:

(instancetype)	- stringsByAddingStrings:

(instancetype)	- stringsByAddingStringsFromArray:

(instancetype)	- stringsByAddingArray:

(void)	- enumerateWithDelegate:

(void)	- enumerate

(void)	- reverseEnumerateWithDelegate:

(void)	- reverseEnumerate

(NSUInteger)	- countByEnumeratingWithState:objects:count:

(void)	- sortAscendingWithSorter:

(void)	- sortDescendingWithSorter:

(void)	- sortWithSorter:

(void)	- sortAscending

(void)	- sortDescending

(void)	- sort

(SCStrings *)	- ascendingSortedStringsWithSorter:

(SCStrings *)	- descendingSortedStringsWithSorter:

(SCStrings *)	- sortedStringsWithSorter:

(void)	- addCollection:

(void)	- addStrings:

(void)	- addLine

(void)	- addStringsFromArray:

(void)	- addArray:

(void)	- insertStrings:atIndex:

(void)	- insertCollection:atIndex:

(void)	- insertCollection:atIndexes:

(void)	- insertLineAtIndex:

(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)	- replaceStringsAtIndexes:withStrings:

(void)	- replaceStringsAtIndexes:withCollection:

(void)	- replaceString:withString:

(void)	- setObject:atIndexedSubscript:

(void)	- exchangeStringAtIndex:withStringAtIndex:

(void)	- duplicateAllStrings

(void)	- copyStringAtIndex:toIndex:

(void)	- moveStringAtIndex:toIndex:

(void)	- forwardMoveStringAtIndex:steps:

(void)	- forwardMoveStringAtIndex:

(void)	- backwardMoveStringAtIndex:steps:

(void)	- backwardMoveStringAtIndex:

(void)	- moveToFirstPositionStringAtIndex:

(void)	- moveToLastPositionStringAtIndex:

(void)	- reverse

(NSString *)	- stringAtIndex:

(SCStrings *)	- stringsAtIndexes:

(id)	- objectAtIndexedSubscript:

(BOOL)	- containsString:

(BOOL)	- containsStrings:

(BOOL)	- containsCollection:

(BOOL)	- containsAnyString:

(BOOL)	- containsAnyStringFromCollection:

(BOOL)	- containsSubstring:

(BOOL)	- containsSubstrings:

(BOOL)	- containsSubstringsFromCollection:

(BOOL)	- containsAnySubstring:

(BOOL)	- containsAnySubstringFromCollection:

(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:

Instance Methods inherited from SCObject
(instancetype)	- initWithContentsOfSerializedFile:

(BOOL)	- writeContentsToSerializedFile:

(instancetype)	- initWithDataDictionaryFromFile:

(void)	- writeToDataDictionaryFile:atomically:

(void)	- writeToDataDictionaryFile:

(NSDictionary *)	- dataDictionary

(instancetype)	- initWithFileStream:

(void)	- writeToFileStream:

(void)	- appendToFileStream:

(instancetype)	- initWithData:

(instancetype)	- initWithContentsOfFile:

(instancetype)	- initWithContentsOfURL:

(instancetype)	- initWithContentsOfURLString:

(BOOL)	- writeToFile:

(BOOL)	- writeToURL:

(BOOL)	- writeToURLString:

(NSData *)	- data

Class Methods inherited from SCStrings
(instancetype)	+ stringsWithCoder:

(instancetype)	+ stringsWithContentsOfSerializedFile:

(instancetype)	+ stringsWithDataDictionary:

(instancetype)	+ stringsWithDataDictionaryFromFile:

(instancetype)	+ stringsWithStream:

(instancetype)	+ stringsWithFileStream:

(instancetype)	+ stringsWithData:

(instancetype)	+ stringsWithContentsOfFile:

(instancetype)	+ stringsWithContentsOfURL:

(instancetype)	+ stringsWithContentsOfURLString:

(instancetype)	+ stringsWithName:

(instancetype)	+ stringsWithString:

(instancetype)	+ stringsWithCollection:

(instancetype)	+ stringsWithArray:

(instancetype)	+ stringsWithStrings:

(instancetype)	+ strings

Properties inherited from SCStrings
NSString *	name

SCIndex	count

BOOL	readOnly

BOOL	empty

BOOL	modified

BOOL	caseInsensitive

id< SCTextDelegate >	delegate

NSEnumerator *	stringEnumerator

NSEnumerator *	reverseStringEnumerator

SCArray *	array

NSArray *	foundationArray

SCStrings *	ascendingSortedStrings

SCStrings *	descendingSortedStrings

SCStrings *	sortedStrings

SCStrings *	reversedStrings

NSString *	firstString

NSString *	lastString

SCIndex	indexOfLastString

Properties inherited from SCObject
NSString *	className

Detailed Description

Unique strings list class.

SDK: macOS 10.6+, iOS 7.0+, GNUstep

Since: version 1.2.0

Class SCUniqueStrings extends the parent class SCString by adding the functionality for support the unique strings lists - each string of this list must be unique. Class SCUniqueStrings instances does not allow adding into the list the duplicated strings. Duplicate string is a string, which is already exists within the list.
Class instances can thrown the following exceptions:

Method Documentation

- (instancetype) initWithUniqueStrings: (SCUniqueStrings *) strings

Initializes an unique strings list using strings from the specified existing unique strings list.

Parameters

strings - the source unique strings list

Returns: A newly initialized unique strings list

Exceptions

SCTextException - text error detected

- (BOOL) isEqualToUniqueStrings: (SCUniqueStrings *) uniqueStrings

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

Parameters

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

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

- (void) setUniqueStrings: (SCUniqueStrings *) uniqueStrings

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

Parameters

uniqueStrings - the source unique strings list

Exceptions

SCTextException - text error detected

+ (instancetype) uniqueStrings

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

Returns: A created unique strings list

- (instancetype) uniqueStringsByAddingArray: (SCArray *) array

Returns the new unique strings list that contains strings from the receiving unique strings list and a given array.

Parameters

array - an array with objects to add to the new unique strings list

Returns: An unique strings list with strings from the receiving unique strings and a given array

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

Since: version 1.2.3

See also: - uniqueStringsByAddingStringsFromArray:

- (instancetype) uniqueStringsByAddingCollection: (id<SCCollection>) collection

Returns the new unique strings list that contains strings from the receiving unique strings list and a given collection of any supported type.

Parameters

collection - a collection with strings for add to the new unique strings list

Returns: An unique strings list with strings from the receiving unique strings and a given collection

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

Since: version 1.2.3

- (instancetype) uniqueStringsByAddingString: (NSString *) string

Returns the new unique strings list that contains strings from the receiving unique strings list and a given string.

Parameters

string - the string to add to the new list

Returns: An unique strings list with strings from the receiving unique strings list and the specified string

Exceptions

SCTextException - text error detected

Since: version 1.2.3

- (instancetype) uniqueStringsByAddingStrings: (SCStrings *) strings

Returns the new unique strings list that contains strings from the receiving unique strings list and a given strings list.

Parameters

strings - a list of strings to add to the new unique strings list

Returns: An unique strings list with strings from the receiving unique strings list and a given strings list

Exceptions

SCTextException - text error detected

Since: version 1.2.3

- (instancetype) uniqueStringsByAddingStringsFromArray: (SCArray *) array

Returns the new unique strings list that contains strings from the receiving unique strings list and a given array.

Parameters

array - an array with objects to add to the new unique strings list

Returns: An unique strings list with strings from the receiving unique strings and a given array

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

Since: version 1.2.3

See also: - uniqueStringsByAddingArray:

- (instancetype) uniqueStringsByAddingUniqueStrings: (SCUniqueStrings *) uniqueStrings

Returns the new unique strings list that contains strings from the receiving unique strings list and a given another unique strings list.

Parameters

uniqueStrings - an unique list of strings to add to the new unique strings list

Returns: An unique strings list with strings from the receiving unique strings list and a given another unique strings list

Exceptions

SCTextException - text error detected

Since: version 1.2.3

+ (instancetype) uniqueStringsWithArray: (SCArray *) array

Returns an unique strings list created by using strings from a given array.

Parameters

array - an array with strings to add to the new list

Returns: A created unique strings list

Exceptions

SCTextException - text error detected

Since: 1.2.3

+ (instancetype) uniqueStringsWithCoder: (NSCoder *) coder

Returns an unique strings list created by using the specified coder.

Parameters

coder - the source coder

Returns: A created unique strings list

+ (instancetype) uniqueStringsWithCollection: (id<SCCollection>) collection

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

Parameters

collection - the source collection

Returns: A created unique strings list

Exceptions

SCTextException	- text error detected
SCCollectionException	- collection error detected

+ (instancetype) uniqueStringsWithContentsOfFile: (NSString *) path

Returns an unique strings list created by using the file with the specified path.

Parameters

path	- the path to the source file

Returns: A created unique strings list

+ (instancetype) uniqueStringsWithContentsOfSerializedFile: (NSString *) path

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

Parameters

path	- the path of the source serialized file

Returns: A created unique strings list

+ (instancetype) uniqueStringsWithContentsOfURL: (NSURL *) url

Returns an unique strings list created by using the specified URL.

Parameters

url	- the source URL

Returns: A created unique strings list

+ (instancetype) uniqueStringsWithContentsOfURLString: (NSString *) urlString

Returns an unique strings list created by using the data from the URL with the specified string.

Parameters

urlString - the string of the source URL

Returns: A created unique strings list

+ (instancetype) uniqueStringsWithData: (NSData *) data

Returns an unique strings list created by using the specified data object.

Parameters

data	- the source data object

Returns: A created unique strings list

+ (instancetype) uniqueStringsWithDataDictionary: (NSDictionary *) dictionary

Returns an unique strings list created by using the specified data dictionary.

Parameters

dictionary - the source data dictionary

Returns: A created unique strings list

+ (instancetype) uniqueStringsWithDataDictionaryFromFile: (NSString *) path

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

Parameters

path	- the path of the source data dictionary file

Returns: A created unique strings list

+ (instancetype) uniqueStringsWithFileStream: (NSString *) path

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

Parameters

path	- the path to the source stream file

Returns: A created unique strings list

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

+ (instancetype) uniqueStringsWithName: (NSString *) name

Returns an unique strings list created by using the specified list name.

Parameters

name	- the list name

Returns: A created unique strings list

+ (instancetype) uniqueStringsWithStream: (SCStream *) stream

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

Parameters

stream - the source stream

Returns: A created unique strings list

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

+ (instancetype) uniqueStringsWithString: (NSString *) string

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

Parameters

string - the source string

Returns: A created unique strings list

Exceptions

SCTextException - text error detected

+ (instancetype) uniqueStringsWithStrings: (SCStrings *) strings

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

Parameters

strings - the source strings list

Returns: A created unique strings list

Exceptions

SCTextException - text error detected

+ (instancetype) uniqueStringsWithUniqueStrings: (SCUniqueStrings *) uniqueStrings

Returns an unqiue strings list created by using the strings from the specified existing source unique strings list.

Parameters

uniqueStrings - the source unique strings list

Returns: A created unique strings list

Exceptions

SCTextException - text error detected

Property Documentation

- (NSOrderedSet *) foundationOrderedSet

readnonatomicassign

Returns a standard ordered set with the copy of all receiving unique strings list strings

- (SCOrderedSet *) orderedSet

readnonatomicassign

Returns an ordered set with the copy of all receiving unique strings list strings

- (SCStrings *) strings

readnonatomicassign

Returns a strings list with the copy of all receiving unique strings list strings

- (BOOL) strongMode

readwritenonatomicassign

Determines the mandatory exception generation when string unique violation is detected.

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

SCUniqueStrings.h
SCUniqueStrings.m

Instance Properties

Creating Unique Strings Lists

Initializing Unique Strings Lists

Copying Unique Strings Lists

Comparing Unique Strings Lists

Converting Unique Strings Lists

Deriving New Unique Strings Lists

Additional Inherited Members

Detailed Description

Method Documentation

Property Documentation