OFMutableString Class Reference

A class for storing and modifying strings. More...

#import <OFMutableString.h>

Inheritance diagram for OFMutableString:

Instance Methods
(void)	- setCharacter:atIndex:
	Sets the character at the specified index.
(void)	- appendUTF8String:
	Appends a UTF-8 encoded C string to the OFMutableString.
(void)	- appendUTF8String:length:
	Appends a UTF-8 encoded C string with the specified length to the OFMutableString.
(void)	- appendCString:encoding:
	Appends a C string with the specified encoding to the OFMutableString.
(void)	- appendCString:encoding:length:
	Appends a C string with the specified encoding and length to the OFMutableString.
(void)	- appendString:
	Appends another OFString to the OFMutableString.
(void)	- appendFormat:
	Appends a formatted string to the OFMutableString.
(void)	- appendFormat:arguments:
	Appends a formatted string to the OFMutableString.
(void)	- prependString:
	Prepends another OFString to the OFMutableString.
(void)	- reverse
	Reverses the string.
(void)	- uppercase
	Converts the string to uppercase.
(void)	- lowercase
	Converts the string to lowercase.
(void)	- capitalize
	Capitalizes the string.
(void)	- insertString:atIndex:
	Inserts a string at the specified index.
(void)	- deleteCharactersInRange:
	Deletes the characters at the specified range.
(void)	- replaceCharactersInRange:withString:
	Replaces the characters at the specified range.
(void)	- replaceOccurrencesOfString:withString:
	Replaces all occurrences of a string with another string.
(void)	- replaceOccurrencesOfString:withString:options:range:
	Replaces all occurrences of a string in the specified range with another string.
(void)	- deleteLeadingWhitespaces
	Deletes all whitespaces at the beginning of the string.
(void)	- deleteTrailingWhitespaces
	Deletes all whitespaces at the end of the string.
(void)	- deleteEnclosingWhitespaces
	Deletes all whitespaces at the beginning and the end of the string.
(void)	- makeImmutable
	Converts the mutable string to an immutable string.
Instance Methods inherited from OFString
(id)	- initWithUTF8String:
	Initializes an already allocated OFString from a UTF-8 encoded C string.
(id)	- initWithUTF8String:length:
	Initializes an already allocated OFString from a UTF-8 encoded C string with the specified length.
(id)	- initWithUTF8StringNoCopy:freeWhenDone:
	Initializes an already allocated OFString from an UTF-8 encoded C string without copying it, if possible.
(id)	- initWithCString:encoding:
	Initializes an already allocated OFString from a C string with the specified encoding.
(id)	- initWithCString:encoding:length:
	Initializes an already allocated OFString from a C string with the specified encoding and length.
(id)	- initWithString:
	Initializes an already allocated OFString with another string.
(id)	- initWithUnicodeString:
	Initializes an already allocated OFString with a unicode string.
(id)	- initWithUnicodeString:byteOrder:
	Initializes an already allocated OFString with a unicode string, assuming the specified byte order if no BOM is found.
(id)	- initWithUnicodeString:length:
	Initializes an already allocated OFString with a unicode string with the specified length.
(id)	- initWithUnicodeString:byteOrder:length:
	Initializes an already allocated OFString with a unicode string with the specified length, assuming the specified byte order if no BOM is found.
(id)	- initWithUTF16String:
	Initializes an already allocated OFString with a UTF-16 string.
(id)	- initWithUTF16String:byteOrder:
	Initializes an already allocated OFString with a UTF-16 string, assuming the specified byte order if no BOM is found.
(id)	- initWithUTF16String:length:
	Initializes an already allocated OFString with a UTF-16 string with the specified length.
(id)	- initWithUTF16String:byteOrder:length:
	Initializes an already allocated OFString with a UTF-16 string with the specified length, assuming the specified byte order if no BOM is found.
(id)	- initWithFormat:
	Initializes an already allocated OFString with a format string.
(id)	- initWithFormat:arguments:
	Initializes an already allocated OFString with a format string.
(id)	- initWithPath:
	Initializes an already allocated OFString with the constructed specified path.
(id)	- initWithPath:arguments:
	Initializes an already allocated OFString with the constructed specified path.
(id)	- initWithContentsOfFile:
	Initializes an already allocated OFString with the contents of the specified file in the specified encoding.
(id)	- initWithContentsOfFile:encoding:
	Initializes an already allocated OFString with the contents of the specified file in the specified encoding.
(id)	- initWithContentsOfURL:
	Initializes an already allocated OFString with the contents of the specified URL.
(id)	- initWithContentsOfURL:encoding:
	Initializes an already allocated OFString with the contents of the specified URL in the specified encoding.
(const char *)	- OF_RETURNS_INNER_POINTER
	Returns the OFString as a UTF-8 encoded C string.
(const char *)	- cStringWithEncoding:
	Returns the OFString as a C string in the specified encoding.
(size_t)	- length
	Returns the length of the string in Unicode characters.
(size_t)	- UTF8StringLength
	Returns the number of bytes the string needs in UTF-8 encoding.
(size_t)	- cStringLengthWithEncoding:
	Returns the number of bytes the string needs in the specified encoding.
(of_comparison_result_t)	- caseInsensitiveCompare:
	Compares the OFString to another OFString without caring about the case.
(of_unichar_t)	- characterAtIndex:
	Returns the Unicode character at the specified index.
(void)	- getCharacters:inRange:
	Copies the Unicode characters in the specified range to the specified buffer.
(of_range_t)	- rangeOfString:
	Returns the range of the first occurrence of the string.
(of_range_t)	- rangeOfString:options:
	Returns the range of the string.
(of_range_t)	- rangeOfString:options:range:
	Returns the range of the string in the specified range.
(BOOL)	- containsString:
	Returns whether the string contains the specified string.
(OFString *)	- substringWithRange:
	Creates a substring with the specified range.
(OFString *)	- stringByAppendingString:
	Creates a new string by appending another string.
(OFString *)	- stringByAppendingPathComponent:
	Creates a new string by appending a path component.
(OFString *)	- stringByPrependingString:
	Creates a new string by prepending another string.
(OFString *)	- stringByReplacingOccurrencesOfString:withString:
	Creates a new string by replacing the occurrences of the specified string with the specified replacement.
(OFString *)	- stringByReplacingOccurrencesOfString:withString:options:range:
	Creates a new string by replacing the occurrences of the specified string in the specified range with the specified replacement.
(OFString *)	- uppercaseString
	Returns the string in uppercase.
(OFString *)	- lowercaseString
	Returns the string in lowercase.
(OFString *)	- capitalizedString
	Returns the string capitalized.
(OFString *)	- stringByDeletingLeadingWhitespaces
	Creates a new string by deleting leading whitespaces.
(OFString *)	- stringByDeletingTrailingWhitespaces
	Creates a new string by deleting trailing whitespaces.
(OFString *)	- stringByDeletingEnclosingWhitespaces
	Creates a new string by deleting leading and trailing whitespaces.
(BOOL)	- hasPrefix:
	Checks whether the string has the specified prefix.
(BOOL)	- hasSuffix:
	Checks whether the string has the specified suffix.
(OFArray *)	- componentsSeparatedByString:
	Separates an OFString into an OFArray of OFStrings.
(OFArray *)	- componentsSeparatedByString:options:
	Separates an OFString into an OFArray of OFStrings.
(OFArray *)	- pathComponents
	Returns the components of the path.
(OFString *)	- lastPathComponent
	Returns the last component of the path.
(OFString *)	- stringByDeletingLastPathComponent
	Returns the directory name of the path.
(intmax_t)	- decimalValue
	Returns the decimal value of the string as an intmax_t.
(uintmax_t)	- hexadecimalValue
	Returns the hexadecimal value of the string as an uintmax_t.
(float)	- floatValue
	Returns the float value of the string as a float.
(double)	- doubleValue
	Returns the double value of the string as a double.
(const of_unichar_t *)	- OF_RETURNS_INNER_POINTER
	Returns the string as an array of Unicode characters.
(const uint16_t *)	- OF_RETURNS_INNER_POINTER
	Returns the string in big endian UTF-16 encoding.
(void)	- writeToFile:
	Writes the string into the specified file using UTF-8 encoding.
(OFString *)	- MD5Hash
	Returns the MD5 hash of the string as an autoreleased OFString.
(OFString *)	- SHA1Hash
	Returns the SHA1 hash of the string as an autoreleased OFString.
(id)	- JSONValue
	Creates an object from the JSON value of the string.
(id)	- objectByDeserializing
	Deserializes the receiver into an object.
(OFString *)	- stringByURLEncoding
	Encodes a string for use in a URL.
(OFString *)	- stringByURLDecoding
	Decodes a string used in a URL.
(OFString *)	- stringByXMLEscaping
	Escapes a string for use in an XML document.
(OFString *)	- stringByXMLUnescaping
	Unescapes XML in the string.
(OFString *)	- stringByXMLUnescapingWithDelegate:
	Unescapes XML in the string and uses the specified delegate for unknown entities.
Instance Methods inherited from OFObject
(id)	- init
	Initializes an already allocated object.
(OFString *)	- className
	Returns the name of the object's class.
(OFString *)	- description
	Returns a description for the object.
(void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool.
(void *)	- allocMemoryWithSize:count:
	Allocates memory for the specified number of items and stores it in the object's memory pool.
(void *)	- resizeMemory:size:
	Resizes memory in the object's memory pool to the specified size.
(void *)	- resizeMemory:size:count:
	Resizes memory in the object's memory pool to the specific number of items of the specified size.
(void)	- freeMemory:
	Frees allocated memory and removes it from the object's memory pool.
(void)	- dealloc
	Deallocates the object.
(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay.
(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay.
(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.
(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread.
(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object.
(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.
(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread.
(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object.
(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.
(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay.
(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay.
(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.
(OFString *)	- stringBySerializing
	Creates a string by serializing the receiver.
Instance Methods inherited from <OFObject>
(BOOL)	- isKindOfClass:
	Returns a boolean whether the object of the specified kind.
(BOOL)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class.
(BOOL)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector.
(IMP)	- methodForSelector:
	Returns the implementation for the specified selector.
(const char *)	- typeEncodingForSelector:
	Returns the type encoding for the specified selector.
(id)	- performSelector:
	Performs the specified selector.
(id)	- performSelector:withObject:
	Performs the specified selector with the specified object.
(id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.
(BOOL)	- isEqual:
	Checks two objects for equality.
(uint32_t)	- hash
	Calculates a hash for the object.
(id)	- retain
	Increases the retain count.
(unsigned int)	- retainCount
	Returns the retain count.
(void)	- release
	Decreases the retain count.
(id)	- autorelease
	Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack.
(id)	- self
	Returns the receiver.
(BOOL)	- isProxy
	Returns whether the object is a proxy object.
Instance Methods inherited from <OFCopying>
(id)	- copy
	Copies the object.
Instance Methods inherited from <OFMutableCopying>
(id)	- mutableCopy
	Creates a mutable copy of the object.
Instance Methods inherited from <OFComparing>
(of_comparison_result_t)	- compare:
	Compares the object with another object.
Instance Methods inherited from <OFSerialization>
(id)	- initWithSerialization:
	Initializes the object with the specified XML element serialization.
(OFXMLElement *)	- XMLElementBySerializing
	Serializes the object into an XML element.
Instance Methods inherited from <OFJSONRepresentation>
(OFString *)	- JSONRepresentation
	Returns the JSON representation of the object as a string.

Additional Inherited Members
Class Methods inherited from OFString
(instancetype)	+ string
	Creates a new OFString.
(instancetype)	+ stringWithUTF8String:
	Creates a new OFString from a UTF-8 encoded C string.
(instancetype)	+ stringWithUTF8String:length:
	Creates a new OFString from a UTF-8 encoded C string with the specified length.
(instancetype)	+ stringWithCString:encoding:
	Creates a new OFString from a C string with the specified encoding.
(instancetype)	+ stringWithCString:encoding:length:
	Creates a new OFString from a C string with the specified encoding and length.
(instancetype)	+ stringWithString:
	Creates a new OFString from another string.
(instancetype)	+ stringWithUnicodeString:
	Creates a new OFString from a unicode string.
(instancetype)	+ stringWithUnicodeString:byteOrder:
	Creates a new OFString from a unicode string, assuming the specified byte order if no BOM is found.
(instancetype)	+ stringWithUnicodeString:length:
	Creates a new OFString from a unicode string with the specified length.
(instancetype)	+ stringWithUnicodeString:byteOrder:length:
	Creates a new OFString from a unicode string with the specified length, assuming the specified byte order if no BOM is found.
(instancetype)	+ stringWithUTF16String:
	Creates a new OFString from a UTF-16 encoded string.
(instancetype)	+ stringWithUTF16String:byteOrder:
	Creates a new OFString from a UTF-16 encoded string, assuming the specified byte order if no BOM is found.
(instancetype)	+ stringWithUTF16String:length:
	Creates a new OFString from a UTF-16 encoded string with the specified length.
(instancetype)	+ stringWithUTF16String:byteOrder:length:
	Creates a new OFString from a UTF-16 encoded string with the specified length, assuming the specified byte order if no BOM is found.
(instancetype)	+ stringWithFormat:
	Creates a new OFString from a format string.
(instancetype)	+ stringWithPath:
	Creates a new OFString containing the constructed specified path.
(instancetype)	+ stringWithContentsOfFile:
	Creates a new OFString with the contents of the specified UTF-8 encoded file.
(instancetype)	+ stringWithContentsOfFile:encoding:
	Creates a new OFString with the contents of the specified file in the specified encoding.
(instancetype)	+ stringWithContentsOfURL:
	Creates a new OFString with the contents of the specified URL.
(instancetype)	+ stringWithContentsOfURL:encoding:
	Creates a new OFString with the contents of the specified URL in the specified encoding.

Detailed Description

A class for storing and modifying strings.

Method Documentation

- (void) appendCString:		(const char*)	cString
encoding:		(of_string_encoding_t)	encoding

Appends a C string with the specified encoding to the OFMutableString.

Parameters

cString	A C string to append
encoding	The encoding of the C string

- (void) appendCString:		(const char*)	cString
encoding:		(of_string_encoding_t)	encoding
length:		(size_t)	cStringLength

Appends a C string with the specified encoding and length to the OFMutableString.

Parameters

cString	A C string to append
encoding	The encoding of the C string
cStringLength	The length of the UTF-8 encoded C string

- (void) appendFormat:		(OFConstantString*)	format
,			...

Appends a formatted string to the OFMutableString.

See printf for the format syntax. As an addition, %@ is available as format specifier for objects.

Parameters

format

A format string which generates the string to append

- (void) appendFormat:		(OFConstantString*)	format
arguments:		(va_list)	arguments

Appends a formatted string to the OFMutableString.

See printf for the format syntax. As an addition, %@ is available as format specifier for objects.

Parameters

format	A format string which generates the string to append
arguments	The arguments used in the format string

- (void) appendString:

(OFString*)

string

Appends another OFString to the OFMutableString.

Parameters

string

An OFString to append

- (void) appendUTF8String:

(const char*)

UTF8String

Appends a UTF-8 encoded C string to the OFMutableString.

Parameters

UTF8String

A UTF-8 encoded C string to append

- (void) appendUTF8String:		(const char*)	UTF8String
length:		(size_t)	UTF8StringLength

Appends a UTF-8 encoded C string with the specified length to the OFMutableString.

Parameters

UTF8String	A UTF-8 encoded C string to append
UTF8StringLength	The length of the UTF-8 encoded C string

- (void) capitalize

Capitalizes the string.

Note

This only considers spaces, tabs and newlines to be word delimiters! Also note that this might change in the future to all word delimiters specified by Unicode!

- (void) deleteCharactersInRange:

(of_range_t)

range

Deletes the characters at the specified range.

Parameters

range

The range of the characters which should be removed

- (void) insertString:		(OFString*)	string
atIndex:		(size_t)	index

Inserts a string at the specified index.

Parameters

string	The string to insert
index	The index

- (void) prependString:

(OFString*)

string

Prepends another OFString to the OFMutableString.

Parameters

string

An OFString to prepend

- (void) replaceCharactersInRange:		(of_range_t)	range
withString:		(OFString*)	replacement

Replaces the characters at the specified range.

Parameters

range	The range of the characters which should be replaced
replacement	The string to the replace the characters with

- (void) replaceOccurrencesOfString:		(OFString*)	string
withString:		(OFString*)	replacement

Replaces all occurrences of a string with another string.

Parameters

string	The string to replace
replacement	The string with which it should be replaced

- (void) replaceOccurrencesOfString:		(OFString*)	string
withString:		(OFString*)	replacement
options:		(int)	options
range:		(of_range_t)	range

Replaces all occurrences of a string in the specified range with another string.

Parameters

string	The string to replace
replacement	The string with which it should be replaced
options	Options modifying search behaviour Possible values: None yet
range	The range in which the string should be replaced

- (void) setCharacter:		(of_unichar_t)	character
atIndex:		(size_t)	index

Sets the character at the specified index.

Parameters

character	The character to set
index	The index where to set the character

---

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

• src/OFMutableString.h
• src/OFMutableString.m