org.rococoa.cocoa.foundation.categories
Interface NSStringExtensionMethods

All Known Implementing Classes:

NSConstantString, NSMutableString, NSSimpleCString, NSString

public interface NSStringExtensionMethods

This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java, Rococoa, or JNA.

Nested Class Summary

static interface

NSStringExtensionMethods._static_

Method Summary

boolean	boolValue() Original signature : -(BOOL)boolValue Skips initial space characters (whitespaceSet), or optional -/+ sign followed by zeroes.
boolean	canBeConvertedToEncoding(int encoding) Original signature : -(BOOL)canBeConvertedToEncoding:(NSStringEncoding)
NSString	capitalizedString()
NSObject	caseInsensitiveCompare(NSString string)
NSString	commonPrefixWithString_options(NSString aString, int mask) Original signature : -(NSString*)commonPrefixWithString:(NSString*) options:(NSStringCompareOptions)
NSObject	compare_options(NSString string, int mask) Original signature : -(id)compare:(NSString*) options:(NSStringCompareOptions)
NSObject	compare(NSString string)
NSArray	componentsSeparatedByCharactersInSet(NSCharacterSet separator)
NSArray	componentsSeparatedByString(NSString separator)
ByteByReference	cStringUsingEncoding(int encoding) Methods to convert NSString to a NULL-terminated cString using the specified encoding.
NSData	dataUsingEncoding_allowLossyConversion(int encoding, boolean lossy) Original signature : -(NSData*)dataUsingEncoding:(NSStringEncoding) allowLossyConversion:(BOOL) External representation
NSData	dataUsingEncoding(int encoding) Original signature : -(NSData*)dataUsingEncoding:(NSStringEncoding) External representation
NSString	decomposedStringWithCanonicalMapping()
NSString	decomposedStringWithCompatibilityMapping()
double	doubleValue() The following convenience methods all skip initial space characters (whitespaceSet) and ignore trailing characters.
int	fastestEncoding()
float	floatValue()
void	getCharacters(char buffer)
boolean	getCString_maxLength_encoding(ByteBuffer buffer, int maxBufferCount, int encoding) Original signature : -(BOOL)getCString:(char*) maxLength:(NSUInteger) encoding:(NSStringEncoding) NO return if conversion not possible due to encoding errors or too small of a buffer.
boolean	getCString_maxLength_encoding(ByteByReference buffer, int maxBufferCount, int encoding) Deprecated. use the safer method getCString_maxLength_encoding(java.nio.ByteBuffer, int, int) instead
int	hash()
boolean	hasPrefix(NSString aString)
boolean	hasSuffix(NSString aString)
NSString	init() In general creation methods in NSString do not apply to subclassers, as subclassers are assumed to provide their own init methods which create the string in the way the subclass wishes.
NSString	initWithBytes_length_encoding(Pointer bytes, int len, int encoding) Original signature : -(id)initWithBytes:(const void*) length:(NSUInteger) encoding:(NSStringEncoding)
NSString	initWithBytesNoCopy_length_encoding_freeWhenDone(Pointer bytes, int len, int encoding, boolean freeBuffer) Original signature : -(id)initWithBytesNoCopy:(void*) length:(NSUInteger) encoding:(NSStringEncoding) freeWhenDone:(BOOL) "NoCopy" is a hint
NSString	initWithCharacters_length(char[] characters, int length)
NSString	initWithCharacters_length(char characters, int length) Deprecated. use the safer methods initWithCharacters_length(char[], int) and initWithCharacters_length(char, int) instead
NSString	initWithCharactersNoCopy_length_freeWhenDone(char characters, int length, boolean freeBuffer) Original signature : -(id)initWithCharactersNoCopy:(unichar*) length:(NSUInteger) freeWhenDone:(BOOL) "NoCopy" is a hint
NSString	initWithContentsOfFile_encoding_error(NSString path, int enc, PointerByReference error) Original signature : -(id)initWithContentsOfFile:(NSString*) encoding:(NSStringEncoding) error:(NSError**)
NSString	initWithContentsOfFile_usedEncoding_error(NSString path, int enc, PointerByReference error) Original signature : -(id)initWithContentsOfFile:(NSString*) usedEncoding:(NSStringEncoding*) error:(NSError**)
NSString	initWithContentsOfURL_encoding_error(NSURL url, int enc, PointerByReference error) These use the specified encoding.
NSString	initWithContentsOfURL_usedEncoding_error(NSURL url, int enc, PointerByReference error) These try to determine the encoding, and return the encoding which was used.
NSString	initWithCString_encoding(ByteByReference nullTerminatedCString, int encoding) Deprecated. use the safer method initWithCString_encoding(java.lang.String, int) instead
NSString	initWithCString_encoding(String nullTerminatedCString, int encoding) Original signature : -(id)initWithCString:(const char*) encoding:(NSStringEncoding)
NSString	initWithData_encoding(NSData data, int encoding) Original signature : -(id)initWithData:(NSData*) encoding:(NSStringEncoding)
NSString	initWithFormat_locale(NSString format, org.rococoa.ID locale, NSObject... varargs)
NSString	initWithFormat(NSString format, NSObject... varargs)
NSString	initWithString(NSString aString)
NSString	initWithUTF8String(ByteByReference nullTerminatedCString) Deprecated. use the safer method initWithUTF8String(java.lang.String) instead
NSString	initWithUTF8String(String nullTerminatedCString)
int	integerValue()
int	intValue()
boolean	isEqualToString(NSString aString)
int	lengthOfBytesUsingEncoding(int enc) Original signature : -(NSUInteger)lengthOfBytesUsingEncoding:(NSStringEncoding) Result in O(n) time; the result is exact
NSObject	localizedCaseInsensitiveCompare(NSString string)
NSObject	localizedCompare(NSString string)
long	longLongValue()
NSString	lowercaseString()
int	maximumLengthOfBytesUsingEncoding(int enc) These return the maximum and exact number of bytes needed to store the receiver in the specified encoding in non-external representation.
NSString	precomposedStringWithCanonicalMapping()
NSString	precomposedStringWithCompatibilityMapping()
NSObject	rangeOfCharacterFromSet_options(NSCharacterSet aSet, int mask) Original signature : -(id)rangeOfCharacterFromSet:(NSCharacterSet*) options:(NSStringCompareOptions)
NSObject	rangeOfCharacterFromSet(NSCharacterSet aSet) These return the range of the first character from the set in the string, not the range of a sequence of characters.
NSObject	rangeOfComposedCharacterSequenceAtIndex(int index)
NSObject	rangeOfString_options(NSString aString, int mask) Original signature : -(id)rangeOfString:(NSString*) options:(NSStringCompareOptions)
NSObject	rangeOfString(NSString aString) These methods return length==0 if the target string is not found.
int	smallestEncoding()
NSString	stringByAppendingFormat(NSString format, NSObject... varargs)
NSString	stringByAppendingString(NSString aString)
NSString	stringByFoldingWithOptions_locale(int options, NSLocale locale) Returns a string with the character folding options applied. theOptions is a mask of compare flags with *InsensitiveSearch suffix.
NSString	stringByPaddingToLength_withString_startingAtIndex(int newLength, NSString padString, int padIndex)
NSString	stringByReplacingOccurrencesOfString_withString(NSString target, NSString replacement) Replace all occurrences of the target string with replacement.
NSString	stringByTrimmingCharactersInSet(NSCharacterSet set)
NSString	substringFromIndex(int from)
NSString	substringToIndex(int to)
NSString	uppercaseString()
ByteByReference	UTF8String() Original signature : -(const char*)UTF8String Convenience to return null-terminated UTF8 representation
boolean	writeToFile_atomically_encoding_error(NSString path, boolean useAuxiliaryFile, int enc, PointerByReference error) Original signature : -(BOOL)writeToFile:(NSString*) atomically:(BOOL) encoding:(NSStringEncoding) error:(NSError**)
boolean	writeToURL_atomically_encoding_error(NSURL url, boolean useAuxiliaryFile, int enc, PointerByReference error) Write to specified url or path using the specified encoding.

Method Detail

getCharacters

void getCharacters(char buffer)

substringFromIndex

NSString substringFromIndex(int from)

substringToIndex

NSString substringToIndex(int to)

compare

NSObject compare(NSString string)

compare_options

NSObject compare_options(NSString string,
                         int mask)

Original signature : -(id)compare:(NSString*) options:(NSStringCompareOptions)

Parameters:

mask - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringCompareOptions

caseInsensitiveCompare

NSObject caseInsensitiveCompare(NSString string)

localizedCompare

NSObject localizedCompare(NSString string)

localizedCaseInsensitiveCompare

NSObject localizedCaseInsensitiveCompare(NSString string)

isEqualToString

boolean isEqualToString(NSString aString)

hasPrefix

boolean hasPrefix(NSString aString)

hasSuffix

boolean hasSuffix(NSString aString)

rangeOfString

NSObject rangeOfString(NSString aString)

These methods return length==0 if the target string is not found. So, to check for containment: ([str rangeOfString:@"target"].length > 0). Note that the length of the range returned by these methods might be different than the length of the target string, due composed characters and such.
Original signature : -(id)rangeOfString:(NSString*)

rangeOfString_options

NSObject rangeOfString_options(NSString aString,
                               int mask)

Original signature : -(id)rangeOfString:(NSString*) options:(NSStringCompareOptions)

Parameters:

mask - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringCompareOptions

rangeOfCharacterFromSet

NSObject rangeOfCharacterFromSet(NSCharacterSet aSet)

These return the range of the first character from the set in the string, not the range of a sequence of characters.
Original signature : -(id)rangeOfCharacterFromSet:(NSCharacterSet*)

rangeOfCharacterFromSet_options

NSObject rangeOfCharacterFromSet_options(NSCharacterSet aSet,
                                         int mask)

Original signature : -(id)rangeOfCharacterFromSet:(NSCharacterSet*) options:(NSStringCompareOptions)

Parameters:

mask - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringCompareOptions

rangeOfComposedCharacterSequenceAtIndex

NSObject rangeOfComposedCharacterSequenceAtIndex(int index)

stringByAppendingString

NSString stringByAppendingString(NSString aString)

stringByAppendingFormat

NSString stringByAppendingFormat(NSString format,
                                 NSObject... varargs)

doubleValue

double doubleValue()

The following convenience methods all skip initial space characters (whitespaceSet) and ignore trailing characters. NSScanner can be used for more "exact" parsing of numbers.
Original signature : -(double)doubleValue

floatValue

float floatValue()

intValue

int intValue()

integerValue

int integerValue()

longLongValue

long longLongValue()

boolValue

boolean boolValue()

Original signature : -(BOOL)boolValue
Skips initial space characters (whitespaceSet), or optional -/+ sign followed by zeroes. Returns YES on encountering one of "Y", "y", "T", "t", or a digit 1-9. It ignores any trailing characters.

componentsSeparatedByString

NSArray componentsSeparatedByString(NSString separator)

componentsSeparatedByCharactersInSet

NSArray componentsSeparatedByCharactersInSet(NSCharacterSet separator)

commonPrefixWithString_options

NSString commonPrefixWithString_options(NSString aString,
                                        int mask)

Original signature : -(NSString*)commonPrefixWithString:(NSString*) options:(NSStringCompareOptions)

Parameters:

mask - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringCompareOptions

uppercaseString

NSString uppercaseString()

lowercaseString

NSString lowercaseString()

capitalizedString

NSString capitalizedString()

stringByTrimmingCharactersInSet

NSString stringByTrimmingCharactersInSet(NSCharacterSet set)

stringByPaddingToLength_withString_startingAtIndex

NSString stringByPaddingToLength_withString_startingAtIndex(int newLength,
                                                            NSString padString,
                                                            int padIndex)

hash

int hash()

fastestEncoding

int fastestEncoding()

See Also:

org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

smallestEncoding

int smallestEncoding()

See Also:

org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

dataUsingEncoding_allowLossyConversion

NSData dataUsingEncoding_allowLossyConversion(int encoding,
                                              boolean lossy)

Original signature : -(NSData*)dataUsingEncoding:(NSStringEncoding) allowLossyConversion:(BOOL)
External representation

Parameters:

encoding - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

dataUsingEncoding

NSData dataUsingEncoding(int encoding)

Original signature : -(NSData*)dataUsingEncoding:(NSStringEncoding)
External representation

Parameters:

encoding - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

canBeConvertedToEncoding

boolean canBeConvertedToEncoding(int encoding)

Original signature : -(BOOL)canBeConvertedToEncoding:(NSStringEncoding)

Parameters:

encoding - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

cStringUsingEncoding

ByteByReference cStringUsingEncoding(int encoding)

Methods to convert NSString to a NULL-terminated cString using the specified encoding. Note, these are the "new" cString methods, and are not deprecated like the older cString methods which do not take encoding arguments.
Original signature : -(const char*)cStringUsingEncoding:(NSStringEncoding)
"Autoreleased"; NULL return if encoding conversion not possible; for performance reasons, lifetime of this should not be considered longer than the lifetime of the receiving string (if the receiver string is freed, this might go invalid then, before the end of the autorelease scope)

Parameters:

encoding - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

getCString_maxLength_encoding

@Deprecated
boolean getCString_maxLength_encoding(ByteByReference buffer,
                                                 int maxBufferCount,
                                                 int encoding)

Deprecated. use the safer method getCString_maxLength_encoding(java.nio.ByteBuffer, int, int) instead

Original signature : -(BOOL)getCString:(char*) maxLength:(NSUInteger) encoding:(NSStringEncoding)
NO return if conversion not possible due to encoding errors or too small of a buffer. The buffer should include room for maxBufferCount bytes; this number should accomodate the expected size of the return value plus the NULL termination character, which this method adds. (So note that the maxLength passed to this method is one more than the one you would have passed to the deprecated getCString:maxLength:.)

Parameters:

encoding - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

getCString_maxLength_encoding

boolean getCString_maxLength_encoding(ByteBuffer buffer,
                                      int maxBufferCount,
                                      int encoding)

Original signature : -(BOOL)getCString:(char*) maxLength:(NSUInteger) encoding:(NSStringEncoding)
NO return if conversion not possible due to encoding errors or too small of a buffer. The buffer should include room for maxBufferCount bytes; this number should accomodate the expected size of the return value plus the NULL termination character, which this method adds. (So note that the maxLength passed to this method is one more than the one you would have passed to the deprecated getCString:maxLength:.)

Parameters:

encoding - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

maximumLengthOfBytesUsingEncoding

int maximumLengthOfBytesUsingEncoding(int enc)

These return the maximum and exact number of bytes needed to store the receiver in the specified encoding in non-external representation. The first one is O(1), while the second one is O(n). These do not include space for a terminating null.
Original signature : -(NSUInteger)maximumLengthOfBytesUsingEncoding:(NSStringEncoding)
Result in O(1) time; the estimate may be way over what's needed

Parameters:

enc - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

lengthOfBytesUsingEncoding

int lengthOfBytesUsingEncoding(int enc)

Original signature : -(NSUInteger)lengthOfBytesUsingEncoding:(NSStringEncoding)
Result in O(n) time; the result is exact

Parameters:

enc - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

decomposedStringWithCanonicalMapping

NSString decomposedStringWithCanonicalMapping()

precomposedStringWithCanonicalMapping

NSString precomposedStringWithCanonicalMapping()

decomposedStringWithCompatibilityMapping

NSString decomposedStringWithCompatibilityMapping()

precomposedStringWithCompatibilityMapping

NSString precomposedStringWithCompatibilityMapping()

stringByFoldingWithOptions_locale

NSString stringByFoldingWithOptions_locale(int options,
                                           NSLocale locale)

Returns a string with the character folding options applied. theOptions is a mask of compare flags with *InsensitiveSearch suffix.
Original signature : -(NSString*)stringByFoldingWithOptions:(NSStringCompareOptions) locale:(NSLocale*)

Parameters:

options - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringCompareOptions

stringByReplacingOccurrencesOfString_withString

NSString stringByReplacingOccurrencesOfString_withString(NSString target,
                                                         NSString replacement)

Replace all occurrences of the target string with replacement. Invokes the above method with 0 options and range of the whole string.
Original signature : -(NSString*)stringByReplacingOccurrencesOfString:(NSString*) withString:(NSString*)

UTF8String

ByteByReference UTF8String()

Original signature : -(const char*)UTF8String
Convenience to return null-terminated UTF8 representation

init

NSString init()

In general creation methods in NSString do not apply to subclassers, as subclassers are assumed to provide their own init methods which create the string in the way the subclass wishes. Designated initializers of NSString are thus init and initWithCoder:.
Original signature : -(id)init

initWithCharactersNoCopy_length_freeWhenDone

NSString initWithCharactersNoCopy_length_freeWhenDone(char characters,
                                                      int length,
                                                      boolean freeBuffer)

Original signature : -(id)initWithCharactersNoCopy:(unichar*) length:(NSUInteger) freeWhenDone:(BOOL)
"NoCopy" is a hint

initWithCharacters_length

@Deprecated
NSString initWithCharacters_length(char characters,
                                              int length)

Deprecated. use the safer methods initWithCharacters_length(char[], int) and initWithCharacters_length(char, int) instead

Original signature : -(id)initWithCharacters:(const unichar*) length:(NSUInteger)

initWithCharacters_length

NSString initWithCharacters_length(char[] characters,
                                   int length)

initWithUTF8String

@Deprecated
NSString initWithUTF8String(ByteByReference nullTerminatedCString)

Deprecated. use the safer method initWithUTF8String(java.lang.String) instead

Original signature : -(id)initWithUTF8String:(const char*)

initWithUTF8String

NSString initWithUTF8String(String nullTerminatedCString)

initWithString

NSString initWithString(NSString aString)

initWithFormat

NSString initWithFormat(NSString format,
                        NSObject... varargs)

initWithFormat_locale

NSString initWithFormat_locale(NSString format,
                               org.rococoa.ID locale,
                               NSObject... varargs)

initWithData_encoding

NSString initWithData_encoding(NSData data,
                               int encoding)

Original signature : -(id)initWithData:(NSData*) encoding:(NSStringEncoding)

Parameters:

encoding - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

initWithBytes_length_encoding

NSString initWithBytes_length_encoding(Pointer bytes,
                                       int len,
                                       int encoding)

Original signature : -(id)initWithBytes:(const void*) length:(NSUInteger) encoding:(NSStringEncoding)

Parameters:

encoding - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

initWithBytesNoCopy_length_encoding_freeWhenDone

NSString initWithBytesNoCopy_length_encoding_freeWhenDone(Pointer bytes,
                                                          int len,
                                                          int encoding,
                                                          boolean freeBuffer)

Original signature : -(id)initWithBytesNoCopy:(void*) length:(NSUInteger) encoding:(NSStringEncoding) freeWhenDone:(BOOL)
"NoCopy" is a hint

Parameters:

encoding - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

initWithCString_encoding

@Deprecated
NSString initWithCString_encoding(ByteByReference nullTerminatedCString,
                                             int encoding)

Deprecated. use the safer method initWithCString_encoding(java.lang.String, int) instead

Original signature : -(id)initWithCString:(const char*) encoding:(NSStringEncoding)

Parameters:

encoding - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

initWithCString_encoding

NSString initWithCString_encoding(String nullTerminatedCString,
                                  int encoding)

Original signature : -(id)initWithCString:(const char*) encoding:(NSStringEncoding)

Parameters:

encoding - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

initWithContentsOfURL_encoding_error

NSString initWithContentsOfURL_encoding_error(NSURL url,
                                              int enc,
                                              PointerByReference error)

These use the specified encoding. If nil is returned, the optional error return indicates problem that was encountered (for instance, file system or encoding errors).
Original signature : -(id)initWithContentsOfURL:(NSURL*) encoding:(NSStringEncoding) error:(NSError**)

Parameters:

enc - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

initWithContentsOfFile_encoding_error

NSString initWithContentsOfFile_encoding_error(NSString path,
                                               int enc,
                                               PointerByReference error)

Original signature : -(id)initWithContentsOfFile:(NSString*) encoding:(NSStringEncoding) error:(NSError**)

Parameters:

enc - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

initWithContentsOfURL_usedEncoding_error

NSString initWithContentsOfURL_usedEncoding_error(NSURL url,
                                                  int enc,
                                                  PointerByReference error)

These try to determine the encoding, and return the encoding which was used. Note that these methods might get "smarter" in subsequent releases of the system, and use additional techniques for recognizing encodings. If nil is returned, the optional error return indicates problem that was encountered (for instance, file system or encoding errors).
Original signature : -(id)initWithContentsOfURL:(NSURL*) usedEncoding:(NSStringEncoding*) error:(NSError**)

Parameters:

enc - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

initWithContentsOfFile_usedEncoding_error

NSString initWithContentsOfFile_usedEncoding_error(NSString path,
                                                   int enc,
                                                   PointerByReference error)

Original signature : -(id)initWithContentsOfFile:(NSString*) usedEncoding:(NSStringEncoding*) error:(NSError**)

Parameters:

enc - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

writeToURL_atomically_encoding_error

boolean writeToURL_atomically_encoding_error(NSURL url,
                                             boolean useAuxiliaryFile,
                                             int enc,
                                             PointerByReference error)

Write to specified url or path using the specified encoding. The optional error return is to indicate file system or encoding errors.
Original signature : -(BOOL)writeToURL:(NSURL*) atomically:(BOOL) encoding:(NSStringEncoding) error:(NSError**)

Parameters:

enc - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding

writeToFile_atomically_encoding_error

boolean writeToFile_atomically_encoding_error(NSString path,
                                              boolean useAuxiliaryFile,
                                              int enc,
                                              PointerByReference error)

Original signature : -(BOOL)writeToFile:(NSString*) atomically:(BOOL) encoding:(NSStringEncoding) error:(NSError**)

Parameters:

enc - @see org.rococoa.cocoa.foundation.FoundationLibrary#NSStringEncoding