AGStringEncoding Class Reference
| Inherits from | NSObject |
| Declared in | AGStringEncoding.h AGStringEncoding.m |
Tasks
-
+ stringEncodingWithString:Creates and returns a new autoreleased AGStringEncoding object initialized by the given string.
-
– initWithString:Returns an AGStringEncoding object initialized by the specified string.
-
– addDecodeSynonyms:Add decoding synonyms as specified in the synonyms argument.
-
– ignoreCharacters:A sequence of characters to ignore if they occur during encoding.
-
– encode:Encode a raw binary buffer to a 7-bit ASCII string.
-
– decode:Decode a 7-bit ASCII string to a raw binary buffer.
Class Methods
stringEncodingWithString:
Creates and returns a new autoreleased AGStringEncoding object initialized by the given string.
+ (id)stringEncodingWithString:(NSString *)stringParameters
- string
The string to use.
Return Value
An AGStringEncoding object initialized by the given string.
Discussion
Creates and returns a new autoreleased AGStringEncoding object initialized by the given string.
Declared In
AGStringEncoding.hInstance Methods
addDecodeSynonyms:
Add decoding synonyms as specified in the synonyms argument.
- (void)addDecodeSynonyms:(NSString *)synonymsParameters
- synonyms
the sequence of synonyms.
Discussion
Add decoding synonyms as specified in the synonyms argument.
It should be a sequence of one previously reverse mapped character, followed by one or more non-reverse mapped character synonyms. Only 7-bit ASCII characters are permitted in the string.
e.g. If a GTMStringEncoder object has already been initialised with a set of characters excluding I, L and O (to avoid confusion with digits) and you want to accept them as digits you can call addDecodeSynonyms:@“0oO1iIlL”.
Declared In
AGStringEncoding.hdecode:
Decode a 7-bit ASCII string to a raw binary buffer.
- (NSData *)decode:(NSString *)stringParameters
- string
The string to decode
Return Value
The raw binary buffer
Discussion
Decode a 7-bit ASCII string to a raw binary buffer.
Declared In
AGStringEncoding.hencode:
Encode a raw binary buffer to a 7-bit ASCII string.
- (NSString *)encode:(NSData *)dataParameters
- data
The data to encode
Return Value
The encoded string
Discussion
Encode a raw binary buffer to a 7-bit ASCII string.
Declared In
AGStringEncoding.hignoreCharacters:
A sequence of characters to ignore if they occur during encoding.
- (void)ignoreCharacters:(NSString *)charsParameters
- chars
The sequence of chars to ignore.
Discussion
A sequence of characters to ignore if they occur during encoding.
Only 7-bit ASCII characters are permitted in the string.
Declared In
AGStringEncoding.hinitWithString:
Returns an AGStringEncoding object initialized by the specified string.
- (id)initWithString:(NSString *)stringParameters
- string
The string to use.
Return Value
An AGStringEncoding object initialized by the given string.
Discussion
Returns an AGStringEncoding object initialized by the specified string.
The length of the string must be a power of 2, at least 2 and at most 128. Only 7-bit ASCII characters are permitted in the string.
These characters are the canonical set emitted during encoding. If the characters have alternatives (e.g. case, easily transposed) then use addDecodeSynonyms: to configure them.
Declared In
AGStringEncoding.h