Class NSString extentions category. More...

#import <NSString+SCString.h>

Creating Strings
(instancetype)	+ stringWithCoder:

(instancetype)	+ stringWithContentsOfSerializedFile:

(instancetype)	+ stringWithDataDictionary:

(instancetype)	+ stringWithDataDictionaryFromFile:

(instancetype)	+ stringWithStream:

(instancetype)	+ stringWithFileStream:

(instancetype)	+ stringWithData:

(instancetype)	+ stringWithContentsOfFile:

(instancetype)	+ stringWithContentsOfURL:

(instancetype)	+ stringWithContentsOfURLString:

(instancetype)	+ stringWithIndexSet:

(instancetype)	+ stringWithCharacter:

(instancetype)	+ stringWithCharacter:length:

(instancetype)	+ stringWithLength:

(instancetype)	+ stringWithPointer:

(instancetype)	+ stringWithID:

(instancetype)	+ stringWithFormat:arguments:

Initializing Strings
(instancetype)	- initWithIndexSet:

(instancetype)	- initWithCharacter:

(instancetype)	- initWithCharacter:length:

(instancetype)	- initWithLength:

(instancetype)	- initWithPointer:

(instancetype)	- initWithID:

Dividing Strings and Replacing Substrings
NSString *	trimmedString

(NSString *)	- ltrim

(NSString *)	- rtrim

(NSString *)	- trim

(NSString *)	- stringWithLeftCharacters:

(NSString *)	- stringWithRightCharacters:

(NSString *)	- skipLeftPart:

(NSString *)	- skipRightPart:

(BOOL)	- isCorrectRange:

(BOOL)	- existsSubstring:caseInsensitive:

(BOOL)	- existsSubstring:

(SCIndex)	- countOfSubstring:caseInsensitive:

(SCIndex)	- countOfSubstring:

(SCIndex)	- indexOfSubstring:caseInsensitive:

(SCIndex)	- indexOfSubstring:

(NSArray *)	- indexesOfSubstring:caseInsensitive:

(NSArray *)	- indexesOfSubstring:

(NSString *)	- stringWithDeletedSubstring:caseInsensitive:

(NSString *)	- stringWithDeletedSubstring:

(NSString *)	- stringWithDeletedSubstringToIndex:

(NSString *)	- stringWithDeletedSubstringToRange:

(NSString *)	- stringWithDeletedSubstringFromIndex:

(NSString *)	- stringWithDeletedSubstringWithRange:

(NSString *)	- stringWithReplacedSubstringToIndex:withString:

(NSString *)	- stringWithReplacedSubstringFromIndex:withString:

(NSString *)	- stringWithReplacedSubstringWithRange:withString:

(NSString *)	- stringWithReplacedSubstring:withString:caseInsensitive:

(NSString *)	- stringWithReplacedSubstring:withString:

(NSString *)	- stringWithInsertedString:

(NSString *)	- stringWithInsertedString:index:

String Words
NSString *	normalizedString

SCIndex	wordsCount

NSString *	firstWord

NSString *	lastWord

NSString *	endOfString

(NSString *)	- word:

Comparing Strings
(BOOL)	- isEqualToStrings:

Expanding Strings
(instancetype)	+ stringWithLeftExpandedString:length:character:

(instancetype)	+ stringWithLeftExpandedString:length:

(instancetype)	+ stringWithLeftZeroExpandedString:length:

(instancetype)	+ stringWithRightExpandedString:length:character:

(instancetype)	+ stringWithRightExpandedString:length:

(NSString *)	- leftExpandedStringToLength:character:

(NSString *)	- leftExpandedStringToLength:

(NSString *)	- leftZeroExpandedStringToLength:

(NSString *)	- rightExpandedStringToLength:character:

(NSString *)	- rightExpandedStringToLength:

(instancetype)	- initWithLeftExpandedString:length:character:

(instancetype)	- initWithLeftExpandedString:length:

(instancetype)	- initWithLeftZeroExpandedString:length:

(instancetype)	- initWithRightExpandedString:length:character:

(instancetype)	- initWithRightExpandedString:length:

Adding Delimiters
(instancetype)	+ stringWithString:separator:left:

(instancetype)	+ stringWithString:spacesLeft:

(instancetype)	+ stringWithString:separator:right:

(instancetype)	+ stringWithString:spacesRight:

(NSString *)	- stringWithSeparator:left:

(NSString *)	- stringWithSpacesLeft:

(NSString *)	- stringWithSeparator:right:

(NSString *)	- stringWithSpacesRight:

(instancetype)	- initWithString:separator:left:

(instancetype)	- initWithString:spacesLeft:

(instancetype)	- initWithString:separator:right:

(instancetype)	- initWithString:spacesRight:

Data Types Representation
BOOL	isBinaryString

BOOL	isOctalString

BOOL	isDecimalString

BOOL	isHexadecimalString

BOOL	isBooleanString

BOOL	isFloatString

BOOL	isDoubleString

SCULong	binaryValue

SCULong	octalValue

SCULong	decimalValue

SCULong	hexadecimalValue

BOOL	booleanValue

(instancetype)	+ stringWithBinaryInteger:capacity:

(instancetype)	+ stringWithBinaryInteger:

(instancetype)	+ stringWithOctalInteger:

(instancetype)	+ stringWithDecimalInteger:separators:

(instancetype)	+ stringWithDecimalInteger:

(instancetype)	+ stringWithInteger:

(instancetype)	+ stringWithHexadecimalInteger:capacity:

(instancetype)	+ stringWithHexadecimalInteger:

(instancetype)	+ stringWithBool:

(instancetype)	+ stringWithFloat:

(instancetype)	+ stringWithDouble:

(instancetype)	- initWithBinaryInteger:capacity:

(instancetype)	- initWithBinaryInteger:

(instancetype)	- initWithOctalInteger:

(instancetype)	- initWithDecimalInteger:separators:

(instancetype)	- initWithDecimalInteger:

(instancetype)	- initWithInteger:

(instancetype)	- initWithHexadecimalInteger:capacity:

(instancetype)	- initWithHexadecimalInteger:

(instancetype)	- initWithBool:

(instancetype)	- initWithFloat:

(instancetype)	- initWithDouble:

Reversing Strings
NSString *	reversedString

(instancetype)	+ stringWithReversedString:

(instancetype)	- initWithReversedString:

Other Properties
BOOL	empty

NSString *	stringWithUpperFirstLetter

Detailed Description

Class NSString extentions category.

SDK: macOS 10.6+, iOS 7.0+, GNUstep

Since: version 1.0.0

Extends the functionality of the standard class NSString by adding the functions for string processing and library support (data dictionaries, collections, streams).

Method Documentation

- (SCIndex) countOfSubstring: (NSString *) substring

Returns a number of occurrences the specified substring into the receiving substring by using the the case sensitive comparison operations.

Parameters

substring - the required substring

Returns: A number of occurrences a given substring

See also: - countOfSubstring:caseInsensitive:

- (SCIndex) countOfSubstring:	(NSString *)	substring
caseInsensitive:	(BOOL)	caseInsensitive

Returns a number of occurrences the specified substring into the receiving substring by using the specified case insensitive flag.

Parameters

substring	- the required substring
caseInsensitive	- YES for case insensitive comparison operations, otherwise NO

Returns: A number of occurrecnes the specified substring

See also: - countOfSubstring:

- (BOOL) existsSubstring: (NSString *) substring

Returns a boolean value that indicates whether the receiving string is contains the specified substring by using the case sensitive comparison operations.

Parameters

substring - the required substring

Returns: YES if the specified substring is present in the receiving string, otherwise NO

See also: - existsSubstring:caseInsensitive:

- (BOOL) existsSubstring:	(NSString *)	substring
caseInsensitive:	(BOOL)	caseInsensitive

Returns a boolean value that indicates whether the receiving string is contains the specified substring by using the specified case insensitive flag.

Parameters

substring	- the required substring
caseInsensitive	- YES for case insensitive comparison operations, otherwise NO

Returns: YES if the specified substring is present in the receiving string, otherwise NO

See also: - existsSubstring:

- (NSArray *) indexesOfSubstring: (NSString *) substring

Returns an array with indexes of all occurrences a given substring into the receiving string by using the case sensitive comparison operations.

Parameters

substring - the desired substring

Returns: An array with indexes

See also: - indexesOfSubstring:caseInsensitive:

- (NSArray *) indexesOfSubstring:	(NSString *)	substring
caseInsensitive:	(BOOL)	caseInsensitive

Returns an array with indexes of all occurrences a given substring into the receiving string by using the specified case insensitive flag.

Parameters

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

Returns: An array with indexes

See also: - indexesOfSubstring:

- (SCIndex) indexOfSubstring: (NSString *) substring

Returns the index of the first occurrence a given substring into the receiving substring by using the case sensitive comparison operations.

Parameters

substring - the desired substring

Returns: An index of the first occurrense of a given substring or SCNotFound if the substring does not found

See also: - indexOfSubstring:caseInsensitive:

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

Returns the index of the first occurence a given substring into the receiving substring by using the specified case insensitive flag.

Parameters

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

Returns: An index of the first occurrense of a given substring or SCNotFound if the substring does not found

See also: - indexOfSubstring:

- (instancetype) initWithBinaryInteger: (SCULong) integer

Initializes a string using a binary representation of the specified 32-bit integer value.

Parameters

integer - the source integer value

Returns: A newly initialized string

See also: - initWithBinaryInteger:capacity:

- (instancetype) initWithBinaryInteger:	(SCULong)	integer
capacity:	(SCCapacity)	capacity

Initializes a string using a binary representation of the specified integer value and a given capacity.

Parameters

integer	- the source integer value
capacity	- the capacity of the integer value: SCByteCapacity - 8-bit integer value SCWordCapacity - 16-bit integer value SCIntCapacity - 32-bit integer value SCLongCapacity - 64-bit integer value

Returns: A newly initialized string

See also: - initWithBinaryInteger:

- (instancetype) initWithBool: (BOOL) boolean

Initializes a string using a representation of the specified boolean value.

Parameters

boolean - the source boolean value

Returns: A newly initialized string

- (instancetype) initWithCharacter: (unichar) character

Initializes a string by using the specified character.

Parameters

character - the source character

Returns: A newly initialized string

- (instancetype) initWithCharacter:	(unichar)	character
length:	(SCIndex)	length

Initializes a string by using the specified number of a given character.

Parameters

character	- the source character
length	- the number of the characters

Returns: A newly initialized string

- (instancetype) initWithDecimalInteger: (SCLong) integer

Initializes a string using a decimal representation of the specified integer value.

Parameters

integer - the source integer value

Returns: A newly initialized string

See also: - initWithDecimalInteger:separators:; - initWithInteger:

- (instancetype) initWithDecimalInteger:	(SCLong)	integer
separators:	(BOOL)	separators

Initializes a string using a decimal representation of the specified integer value and flag of using the digit group delimiters.

Parameters

integer	- the source integer value
separators	- YES for using digit group delimiters and NO for initializing string without digit group delimiters

Returns: A newly initialized string

See also: - initWithDecimalInteger:; - initWithInteger:

- (instancetype) initWithDouble: (SCDouble) value

Initializes a string using a representation of the specified double value.

Parameters

value - the source double value

Returns: A newly initialized string

- (instancetype) initWithFloat: (SCFloat) value

Initializes a string using a representation of the specified float value.

Parameters

value - the source float value

Returns: A newly initialized string

- (instancetype) initWithHexadecimalInteger: (SCULong) integer

Initializes a string using a hexadecimal representation of the specified integer value.

Parameters

integer - the source integer value

Returns: A newly initialized string

See also: - initWithHexadecimalInteger:capacity:

- (instancetype) initWithHexadecimalInteger:	(SCULong)	integer
capacity:	(SCCapacity)	capacity

Initializes a string using a hexadecimal representation of the specified integer value and a given capacity.

Parameters

integer	- the source integer value
capacity	- the capacity of the integer value: SCByteCapacity - 8-bit integer value SCWordCapacity - 16-bit integer value SCIntCapacity - 32-bit integer value SCLongCapacity - 64-bit integer value

Returns: A newly initialized string

See also: - initWithHexadecimalInteger:

- (instancetype) initWithID: (id) object

Initializes a string by using the specified class instance.

Parameters

object - the source class instance

Returns: A newly initialized string

- (instancetype) initWithIndexSet: (NSIndexSet *) indexSet

Initializes a string by using the specified index set.

Parameters

indexSet - the source index set

Returns: A newly initialized string

- (instancetype) initWithInteger: (SCLong) integer

Initializes a string using a decimal representation of the specified integer value.

Parameters

integer - the source integer value

Returns: A newly initialized string

See also: - initWithDecimalInteger:separators:; - initWithDecimalInteger:

- (instancetype) initWithLeftExpandedString:	(NSString *)	string
length:	(SCIndex)	length

Initializes a string by padding the specified source string on the left with the spaces to a given length.

Parameters

string	- the source string
length	- the required length of the initialized string

Returns: A newly initialized string

- (instancetype) initWithLeftExpandedString:	(NSString *)	string
length:	(SCIndex)	length
character:	(unichar)	character

Initializes a string by padding the specified source string on the left with the specified character to a given length.

Parameters

string	- the source string
length	- the required length of the initialized string
character	- the character to padding

Returns: A newly initialized string

- (instancetype) initWithLeftZeroExpandedString:	(NSString *)	string
length:	(SCIndex)	length

Initializes a string by padding the specified source string on the left with the zero characters to a given length.

Parameters

string	- the source string
length	- the required length of the initialized string

Returns: A newly initialized string

- (instancetype) initWithLength: (SCUInteger) length

Initializes a string by using the specified number of the space characters.

Parameters

length - the length of the new string

Returns: A newly initialized string

- (instancetype) initWithOctalInteger: (SCULong) integer

Initializes a string using an octal representation of the specified integer value.

Parameters

integer - the source integer value

Returns: A newly initialized string

- (instancetype) initWithPointer: (void *) pointer

Initializes a string by using the specified pointer.

Parameters

pointer - the source pointer

Returns: A newly initialized string

- (instancetype) initWithReversedString: (NSString *) string

Initializes a string using the characters from a given string in the reversed order.

Parameters

string - the source string

Returns: A newly initialized string

- (instancetype) initWithRightExpandedString:	(NSString *)	string
length:	(SCIndex)	length

Initializes a string by padding the specified source string on the right with the spaces to a given length.

Parameters

string	- the source string
length	- the reqyuired length of the initialized string

Returns: A newly initialized string

- (instancetype) initWithRightExpandedString:	(NSString *)	string
length:	(SCIndex)	length
character:	(unichar)	character

Initializes a string by padding the specified source string on the right with the specified character to a given length.

Parameters

string	- the source string
length	- the required length of the initialized string
character	- the character to padding

Returns: A newly initialized string

- (instancetype) initWithString:	(NSString *)	string
separator:	(NSString *)	separator
left:	(SCIndex)	left

Initializes a string by adding a given group separators after the specified number of characters from left to right of the specified source string.

Parameters

string	- the source string
separator	- the separator to add into the initialized string
left	- the number of characters within the each group

Returns: A newly initialized string

- (instancetype) initWithString:	(NSString *)	string
separator:	(NSString *)	separator
right:	(SCIndex)	right

Initializes a string by adding a given group separators after the specified number of characters from right to left of the specified source string.

Parameters

string	- the source string
separator	- the separator to add into the initialized string
right	- the number of characters within the each group

Returns: A newly initialized string

- (instancetype) initWithString:	(NSString *)	string
spacesLeft:	(SCIndex)	left

Initializes a string by adding the spaces as a group separators after the specified number of characters from left to right of the specified source string.

Parameters

string	- the source string
left	- the number of characters within the each group

Returns: A newly initialized string

- (instancetype) initWithString:	(NSString *)	string
spacesRight:	(SCIndex)	right

Initializes a string by adding the spaces as a group separators after the specified number of characters from right to left of the specified source string.

Parameters

string	- the source string
right	- the number of characters within the each group

Returns: A newly initialized string

- (BOOL) isCorrectRange: (NSRange) range

Returns a boolean value that indicates whether the specified characters range is correct within the receiving string.

Parameters

range - the characters range to check

Returns: YES if the specified range is correct, otherwise NO

- (BOOL) isEqualToStrings:	(NSString *)	string
,		NS_REQUIRES_NIL_TERMINATION

Returns a boolean value that indicates whether the receiving string is equal to any string from a given string list.

Parameters

string	- the first string to compare with the receiving string
...	- a null-terminated list of alternating strings to compare
NS_REQUIRES_NIL_TERMINATION	- the mandatory nil pointer

Returns: YES if the receiving string is equal to any string within the list, otherwise NO

- (NSString *) leftExpandedStringToLength: (SCIndex) length

Returns a receiving string padded on the left by the spaces to the specified length.

Parameters

length - the required string length

Returns: A padded string

- (NSString *) leftExpandedStringToLength:	(SCIndex)	length
character:	(unichar)	character

Returns a receiving string padded on the left of the specified character to the specified length.

Parameters

length	- the required string length
character	- the padding character

Returns: A padded string

- (NSString *) leftZeroExpandedStringToLength: (SCIndex) length

Returns a receiving string padded on the left by the zero characters to the specified length.

Parameters

length - the required string length

Returns: A padded string

- (NSString *) ltrim

Returns the receiving string without the leading spaces and tabs.

Returns: A string without the leading spaces and tabs.

- (NSString *) rightExpandedStringToLength: (SCIndex) length

Returns a receiving string padded on the right by the spaces to the specified length.

Parameters

length - the required length of the string

Returns: A padded string

- (NSString *) rightExpandedStringToLength:	(SCIndex)	length
character:	(unichar)	character

Returns a receiving string padded on the right by the specified character to the specified length.

Parameters

length	- the required string length
character	- the padding character

Returns: A padded string

- (NSString *) rtrim

Returns the receiving string without the trailing spaces and tabs.

Returns: A string without the trailing spaces and tabs.

- (NSString *) skipLeftPart: (SCIndex) characters

Returns a receiving string without the specified number of the leading characters.

Parameters

characters - the number of the characters to remove

Returns: A string without the removed characters

- (NSString *) skipRightPart: (SCIndex) characters

Returns a string without the specified number of the trailing characters.

Parameters

characters - the number of the characters to remove

Returns: A string without the removed characters

+ (instancetype) stringWithBinaryInteger: (SCULong) integer

Returns a string created by using a binary representation of the specified 32-bit integer value.

Parameters

integer - the source integer value

Returns: A created string

See also: + stringWithBinaryInteger:capacity:

+ (instancetype) stringWithBinaryInteger:	(SCULong)	integer
capacity:	(SCCapacity)	capacity

Returns a string created by using a binary representation of the specified integer value and a given capacity:

Parameters

integer	- the source integer value
capacity	- the capacity of the integer value: SCByteCapacity - 8-bit integer value SCWordCapacity - 16-bit integer value SCIntCapacity - 32-bit integer value SCLongCapacity - 64-bit integer value

Returns: A created string

See also: + stringWithBinaryInteger:

+ (instancetype) stringWithBool: (BOOL) boolean

Returns a string created by using a representation of the specified boolean value.

Parameters

boolean - the source boolean value

Returns: A created string

+ (instancetype) stringWithCharacter: (unichar) character

Returns a string created by using the specfied character.

Parameters

character - the source character

Returns: A created string

+ (instancetype) stringWithCharacter:	(unichar)	character
length:	(SCIndex)	length

Returns a string created by using the specified character and a length of the new string.

Parameters

character	- the source character
length	- the length of the new string

Returns: A created string

+ (instancetype) stringWithCoder: (NSCoder *) coder

Returns a string created by using the data from the specified coder.

Parameters

coder - the source coder

Returns: A created string

+ (instancetype) stringWithContentsOfFile: (NSString *) path

Returns a string created by using the data from the file with the specified file.

Parameters

path	- the path of the source file

Returns: A created string

+ (instancetype) stringWithContentsOfSerializedFile: (NSString *) path

Returns a string created by using the data from the serialized file with the specified path.

Parameters

path	- the path of the serialized file

Returns: A created string

+ (instancetype) stringWithContentsOfURL: (NSURL *) url

Returns a string created by using the data from the specified URL.

Parameters

url	- the source URL

Returns: A created string

+ (instancetype) stringWithContentsOfURLString: (NSString *) urlString

Returns a string created by using the data from the URL with the specified string.

Parameters

urlString - the string of the URL

Returns: A created string

+ (instancetype) stringWithData: (NSData *) data

Returns a string created by using the specified data object.

Parameters

data	- the source data object

Returns: A created string

+ (instancetype) stringWithDataDictionary: (NSDictionary *) dictionary

Returns a string created by using the data from the specified data dictionary.

Parameters

dictionary - the source data dictionary

Returns: A created string

+ (instancetype) stringWithDataDictionaryFromFile: (NSString *) path

Returns a string created by using the data from the dictionary file with the specified path.

Parameters

path	- the path to the source dictionary file

Returns: A created string

+ (instancetype) stringWithDecimalInteger: (SCLong) integer

Returns a string created by using a decimal representation of the specified integer value.

Parameters

integer - the source integer value

Returns: A created string

See also: + stringWithDecimalInteger:separators:; + stringWithInteger:

+ (instancetype) stringWithDecimalInteger:	(SCLong)	integer
separators:	(BOOL)	separators

Returns a string created by using a decimal representation of the specified integer value and a flag of using the digit group delimiters.

Parameters

integer	- the source integer value
separators	- YES for using the digit group delimiters and NO for creating string without digit group delimiters

Returns: A created string

See also: + stringWithDecimalInteger:; + stringWithInteger:

- (NSString *) stringWithDeletedSubstring: (NSString *) substring

Returns the receiving string without a given substring by using the case sensitive comparison operations.

Parameters

substring - the substring to remove

Returns: A string without the specified substring

See also: - stringWithDeletedSubstring:caseInsensitive:

- (NSString *) stringWithDeletedSubstring:	(NSString *)	substring
caseInsensitive:	(BOOL)	caseInsensitive

Returns the receiving string without a given substring by using the specified case insensitive flag.

Parameters

substring	- the substring to remove
caseInsensitive	- YES for case insensitive comparison operations, otherwise NO

Returns: A string without the specified substring

See also: - stringWithDeletedSubstring:

- (NSString *) stringWithDeletedSubstringFromIndex: (SCIndex) index

Returns the receiving string without characters after the specified index.

Parameters

index - the index of the first character to remove

Returns: A string without characters

- (NSString *) stringWithDeletedSubstringToIndex: (SCIndex) index

Returns the receiving string without the characters before a given index.

Parameters

index - the index of the last removed character

Returns: A string without characters

- (NSString *) stringWithDeletedSubstringToRange: (NSRange) range

Returns the receiving string with characters after a given range.

Parameters

range - the range of the characters

Returns: A string without characters

- (NSString *) stringWithDeletedSubstringWithRange: (NSRange) range

Returns the receiving string without characters within the specified range.

Parameters

range - the range of characters to remove

Returns: A string without characters

+ (instancetype) stringWithDouble: (SCDouble) value

Return a string created by using a representation of the specified double value.

Parameters

value - the source double value

Returns: A created string

+ (instancetype) stringWithFileStream: (NSString *) path

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

Parameters

path	- the path to the source file stream

Returns: A created string

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

+ (instancetype) stringWithFloat: (SCFloat) value

Returns a string created by using a representation of the specified float value.

Parameters

value - the source float value

Returns: A created string

+ (instancetype) stringWithFormat:	(NSString *)	format
arguments:	(va_list)	arguments

Returns a string created by using a given format string as a template into which the remaining arguments are substituted without any localization.

Parameters

format	- a format string
arguments	- a list of arguments to substitute into a format string

Returns: A created string

Since: version 1.2.4

+ (instancetype) stringWithHexadecimalInteger: (SCULong) integer

Returns a string created by using a hexadecimal representation of the specified integer value.

Parameters

integer - the source integer value

Returns: A created string

See also: + stringWithHexadecimalInteger:capacity:

+ (instancetype) stringWithHexadecimalInteger:	(SCULong)	integer
capacity:	(SCCapacity)	capacity

Returns a string created by using a hexadecimal representation of the specified integer value and a given capacity.

Parameters

integer	- the source integer value
capacity	- the capacity of the integer value: SCByteCapacity - 8-bit integer value SCWordCapacity - 16-bit integer value SCIntCapacity - 32-bit integer value SCLongCapacity - 64-bit integer value

Returns: A created string

See also: + stringWithHexadecimalInteger:

+ (instancetype) stringWithID: (id) object

Returns a string created by using the specified object.

Parameters

object - the source object

Returns: A created string

+ (instancetype) stringWithIndexSet: (NSIndexSet *) indexSet

Returns a string created by using the specified index set.

Parameters

indexSet - the source index set

Returns: A created string

- (NSString *) stringWithInsertedString: (NSString *) string

Returns the receiving string with a given substring before the first character.

Parameters

string - the substring to insert

Returns: A string with the substring

- (NSString *) stringWithInsertedString:	(NSString *)	string
index:	(SCUInteger)	index

Inserts the specified substring at a given index and returns the new string.

Parameters

string	- the substring to insert
index	- the index to the inserting a substring

Returns: A string with the substring

+ (instancetype) stringWithInteger: (SCLong) integer

Returns a string created by using a decimal representation of the specified integer value.

Parameters

integer - the source integer value

Returns: A created string

See also: + stringWithDecimalInteger:separators:; + stringWithDecimalInteger:

- (NSString *) stringWithLeftCharacters: (SCIndex) characters

Returns a string with the specified number of the leading characters from the receiving string.

Parameters

characters - the number of the leading characters

Returns: A string with the specified number of the leading characters

+ (instancetype) stringWithLeftExpandedString:	(NSString *)	string
length:	(SCIndex)	length

Returns a string created by padding the specified source string on the left with the spaces to a given length.

Parameters

string	- the source string
length	- the required length of the new string

Returns: A created string

+ (instancetype) stringWithLeftExpandedString:	(NSString *)	string
length:	(SCIndex)	length
character:	(unichar)	character

Returns a string created by padding the specified source string on the left with the specified character to a given length.

Parameters

string	- the source string
length	- the required length of the new string
character	- the character to padding

Returns: A created string

+ (instancetype) stringWithLeftZeroExpandedString:	(NSString *)	string
length:	(SCIndex)	length

Returns a string created by padding the specified source string on the left with the zero characters to a given length.

Parameters

string	- the source string
length	- the required length of the new string

Returns: A created string

+ (instancetype) stringWithLength: (SCUInteger) length

Returns a string created by using the specified number of the space characters.

Parameters

length - the length of the new string

Returns: A created string

+ (instancetype) stringWithOctalInteger: (SCULong) integer

Returns a string created by using an octal representation of the specified integer value.

Parameters

integer - the source integer value

Returns: A created string

+ (instancetype) stringWithPointer: (void *) pointer

Returns a string created by using the specified pointer.

Parameters

pointer - the source pointer

Returns: A created string

- (NSString *) stringWithReplacedSubstring:	(NSString *)	substring
withString:	(NSString *)	string

Returns the receiving string in which all occurrences of the specified substring are replaced by using an another given string.

Parameters

substring	- the substring to replace
string	- the new substring

Returns: A string with the replaced substring

See also: stringWithReplaceSubstring:withString:caseInsensitive:

- (NSString *) stringWithReplacedSubstring:	(NSString *)	substring
withString:	(NSString *)	string
caseInsensitive:	(BOOL)	caseInsensitive

Returns the receiving string in which all occurrences of the specified substring are replaced by using an another given string.@ Additional flag defines the case sensitive mode.

Parameters

substring	- the substring to replace
string	- the new substring
caseInsensitive	- YES for the case insensitive mode and NO for the case sensitive comparison operations

Returns: A string with the replaced substring

See also: stringWithReplacedSubstring:withSubstring:

- (NSString *) stringWithReplacedSubstringFromIndex:	(SCUInteger)	index
withString:	(NSString *)	string

Returns the receiving string with the specified number of the trailing characters is replaced by a given substring.

Parameters

index	- the index of the first character to replace
string	- the substring with which will be replaced the specified characters

Returns: A string with the replaced characters

- (NSString *) stringWithReplacedSubstringToIndex:	(SCUInteger)	index
withString:	(NSString *)	string

Returns the receiving string with the specified number of the leading characters is replaced by a given substring.
If the specified substring is empty, then returns the receiving string without the characters before the specified index.

Parameters

index	- the index of the last character to replace
string	- the substring with which will be replaced the specified characters

Returns: A string with the replaced characters

- (NSString *) stringWithReplacedSubstringWithRange:	(NSRange)	range
withString:	(NSString *)	string

Returns the receiving string with the characters within a given range are replaced by the specified substring.

Parameters

range	- the range of the characters to replace
string	- the substring with which will be replaced the specified characters

Returns: A string with the replaced characters

+ (instancetype) stringWithReversedString: (NSString *) string

Returns a string created by using the characters from a given string in the reversed order.

Parameters

string - the source string

Returns: A created string

- (NSString *) stringWithRightCharacters: (SCIndex) characters

Returns a string with the specified number of the trailing characters from the receiving string.

Parameters

characters - the number of the trailing characters

Returns: A string with the specified number of the trailing characters

+ (instancetype) stringWithRightExpandedString:	(NSString *)	string
length:	(SCIndex)	length

Returns a string created by padding the specified source string on the right with the spaces to a given length.

Parameters

string	- the source string
length	- the required length of the new string

Returns: A created string

+ (instancetype) stringWithRightExpandedString:	(NSString *)	string
length:	(SCIndex)	length
character:	(unichar)	character

Returns a string created by padding the specified source string on the right with the specified character to a given length.

Parameters

string	- the source string
length	- the required length of the new string
character	- the character to padding

Returns: A created string

- (NSString *) stringWithSeparator:	(NSString *)	separator
left:	(SCIndex)	left

Returns a string with the added given group separators after the specified number of characters from the left to right of the receiving string.

Parameters

separator	- the separator to add into the receiving string
left	- the number of the characters within the each group

Returns: A string with the group separators

- (NSString *) stringWithSeparator:	(NSString *)	separator
right:	(SCIndex)	right

Returns a string with the added given group separators after the specified number of characters from right to left of the receiving string.

Parameters

separator	- the separator to add into the receiving string
right	- the number of the characters within the each group

Returns: A string with the group separators

- (NSString *) stringWithSpacesLeft: (SCIndex) left

Returns a string with the added spaces as a group separators after the specified number of character from the left to right of the receiving string.

Parameters

left	- the number of the characters within the each group

Returns: A string with the group separators

- (NSString *) stringWithSpacesRight: (SCIndex) right

Returns a string with the added spaces as a group separators after the specified number of characters from the left to right of the receiving string.

Parameters

right - the number of the characters within the each group

Returns: A string with the group separators

+ (instancetype) stringWithStream: (SCStream *) stream

Returns a string created by using the data from the specified stream.

Parameters

stream - the source stream

Returns: A created string

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

+ (instancetype) stringWithString:	(NSString *)	string
separator:	(NSString *)	separator
left:	(SCIndex)	left

Returns a string created by adding a given group separators after the specified number of characters from left to right of the specified source string.

Parameters

string	- the source string
separator	- the separator to add into the created string
left	- the number of the characters within the each griup

Returns: A created string

+ (instancetype) stringWithString:	(NSString *)	string
separator:	(NSString *)	separator
right:	(SCIndex)	right

Returns a string created by adding a given group separators after the specified number of characters from right to left of the specified source string.

Parameters

string	- the source string
separator	- the separator to add into the created string
right	- the number of the characters within the each group

Returns: A created string

+ (instancetype) stringWithString:	(NSString *)	string
spacesLeft:	(SCIndex)	left

Returns a string created by adding the spaces as a group separators after the specified number of characters from left to right of the specified source string.

Parameters

string	- the source string
left	- the number of the characters within the each group

Returns: A created string

+ (instancetype) stringWithString:	(NSString *)	string
spacesRight:	(SCIndex)	right

Returns a string created by adding the spaces as a group separators after the specified number of characters from right to left of the specified source string.

Parameters

string	- the source string
right	- the number of the characters within the each group

Returns: A created string

- (NSString *) trim

Returns the receiving string without leading and trailing spaces and tabs.

Returns: A string without leading and trailing spaces and tabs

- (NSString *) word: (SCIndex) word

Returns the word of the receiving string at the specified index.

Parameters

word	- the index of the word

Returns: The word at a given index of empty string if the index is incorrect

Property Documentation

- (SCULong) binaryValue

readnonatomicassign

The integer value of the binary integer string

- (BOOL) booleanValue

readnonatomicassign

The boolean value of the string

- (SCULong) decimalValue

readnonatomicassign

The integer value of the decimal integer string

- (BOOL) empty

readnonatomicassign

The boolean value that detrmines whether the string is contains at least one character

- (NSString *) endOfString

readnonatomicassign

String without the first word

- (NSString *) firstWord

readnonatomicassign

First word of the receiving string

- (SCULong) hexadecimalValue

readnonatomicassign

The integer value of the hexadecimal integer string

- (BOOL) isBinaryString

readnonatomicassign

A boolean value that indicates whether the string is a binary representation of the integer value

- (BOOL) isBooleanString

readnonatomicassign

A boolean value that indicates whether the string is a boolean value representation

- (BOOL) isDecimalString

readnonatomicassign

A boolean value that indicates whether the string is a decimal representation of the integer value

- (BOOL) isDoubleString

readnonatomicassign

A boolean value that indicates whether the string is a representation of the double floating-point value

- (BOOL) isFloatString

readnonatomicassign

A boolean value that indicates whether the string is a representation of the float floating-point value

- (BOOL) isHexadecimalString

readnonatomicassign

A boolean value that indicates whether the string is a hexadecimal representation of the integer value

- (BOOL) isOctalString

readnonatomicassign

A boolean value that indicates whether the string is an octal representation of the integer value

- (NSString *) lastWord

readnonatomicassign

Last word of the receiving string

- (NSString *) normalizedString

readnonatomicassign

Normilized string

- (SCULong) octalValue

readnonatomicassign

The integer value of the octal integer string

- (NSString *) reversedString

readnonatomicassign

The string with the reversed order of the characters

- (NSString *) stringWithUpperFirstLetter

readnonatomicassign

A string with the first uppercase character

- (NSString *) trimmedString

readnonatomicassign

A string without leading and trailing spaces and tabs

- (SCIndex) wordsCount

readnonatomicassign

Number of words within the receiving string

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

NSString+SCString.h
NSString+SCString.m

Creating Strings

Initializing Strings

Dividing Strings and Replacing Substrings

String Words

Comparing Strings

Expanding Strings

Adding Delimiters

Data Types Representation

Reversing Strings

Other Properties

Detailed Description

Method Documentation

Property Documentation