crossmobile.ios.foundation

Class NSString

java.lang.Object

crossmobile.ios.foundation.NSObject

crossmobile.ios.foundation.NSString

All Implemented Interfaces:

NSSecureCoding

public class NSString
extends NSObject
implements NSSecureCoding

NSString class defines an object that is the foundation of the textual functionality of the application.

Method Summary

Modifier and Type	Method and Description
static boolean	canBeConvertedToEncoding(String self, int NSStringEncoding) Check whether a string can be converted to the specified encoding
static int	compare(String self, String with, int NSStringCompareOptions) Compares the given Strings using the specified options.
static List<String>	componentsSeparatedByString(String self, String separator) Returns a list that contains the substrings of the specified String divided by the given separator.
static NSData	dataUsingEncoding(String string, int NSStringEncoding) Returns an NSData object that represents the given String encoded using the specified NSStringEncoding.
static CGSize	drawAtPoint(String self, CGPoint point, UIFont font) Deprecated.
static String	initWithData(NSData data, int NSStringEncoding) Returns a String that is encoded representation of the given NSData object of the specified encoding.
static String	initWithFormat(String format, NSLocale loc, Object... args) Get a localized version of a formatted String
static String	initWithFormat(String format, Object... args) Create a String based on the provided format
static String	localizedStringWithFormat(String format, Object... args) Get a localized version of a formatted String using current locale
static CGSize	sizeWithFont(String self, UIFont font) Deprecated.
static CGSize	sizeWithFont(String self, UIFont font, CGSize size, int NSLineBreakMode) Deprecated.
static String	stringByAddingPercentEscapesUsingEncoding(String self, int NSStringEncoding) Creates and returns a new NSString object by adding percent escapes in order to convert it to a legal URL.
static String	stringByReplacingCharactersInRange(String self, NSRange range, String replacement) Return a new string, where the content inside range is replaced with replacement
static String	stringByReplacingPercentEscapesUsingEncoding(String self, int NSStringEncoding) Creates and returns a new NSString object from the interpretation of the specified URL replacing all percent escapes with the matching characters using the specified encoding.
static String	stringWithContentsOfFile(String path) Deprecated.
static String	stringWithContentsOfFile(String path, int NSStringEncoding, crossmobile.rt.StrongReference<NSError> error) Returns a String that is the result of reading data from the specified file.
static String	stringWithContentsOfURL(NSURL url) Deprecated.
static String	stringWithContentsOfURL(NSURL url, int NSStringEncoding, crossmobile.rt.StrongReference<NSError> error) Deprecated.
static boolean	writeToFile(String self, String path, boolean atomically, int NSStringEncoding, crossmobile.rt.StrongReference<NSError> error) Writes the specified content to the specified file using the given encoding.

Methods inherited from class crossmobile.ios.foundation.NSObject

addObserver, observeValueForKeyPath, performSelector, performSelectorOnMainThread, release, removeObserver, removeObserver, retain, setValueForKey, setValueForUndefinedKey, valueForKey, valueForUndefinedKey

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface crossmobile.ios.foundation.NSSecureCoding

supportsSecureCoding

Method Detail

dataUsingEncoding

public static NSData dataUsingEncoding(String string,
                                       int NSStringEncoding)

Returns an NSData object that represents the given String encoded using the specified NSStringEncoding.

Parameters:

string - The initial String that is converted to a NSData object.

NSStringEncoding - The String encoding that is used.

Returns:

The final NSData object.

stringWithContentsOfURL

@Deprecated
public static String stringWithContentsOfURL(NSURL url,
                                                         int NSStringEncoding,
                                                         crossmobile.rt.StrongReference<NSError> error)

Deprecated.

Returns a String that is the result of reading data from the specified URL using the given encoding.

Parameters:

url - The URL from which to read data.

NSStringEncoding - The encoding that is used.

error - The error that occurs in case of failure.NULL when there the error description is useless.

Returns:

The final String.

stringWithContentsOfURL

@Deprecated
public static String stringWithContentsOfURL(NSURL url)

Deprecated.

Returns a String that is the interpretation of the specified URL.

Parameters:

url - The URL that is interpreted.

Returns:

The final String.

stringWithContentsOfFile

@Deprecated
public static String stringWithContentsOfFile(String path)

Deprecated.

Returns a String that is the result of reading data from the specified file.

Parameters:

path - The path of the file.

Returns:

The final String.

stringWithContentsOfFile

public static String stringWithContentsOfFile(String path,
                                              int NSStringEncoding,
                                              crossmobile.rt.StrongReference<NSError> error)

Returns a String that is the result of reading data from the specified file.

Parameters:

path - The path of the file.

NSStringEncoding - the file encoding

error - The error that occurs in case of failure

Returns:

The final String.

canBeConvertedToEncoding

public static boolean canBeConvertedToEncoding(String self,
                                               int NSStringEncoding)

Check whether a string can be converted to the specified encoding

Parameters:

self - the String to check if it can be converted

NSStringEncoding - the desired encoding

Returns:

true if the self can be converted

See Also:

NSStringEncoding

stringByReplacingCharactersInRange

public static String stringByReplacingCharactersInRange(String self,
                                                        NSRange range,
                                                        String replacement)

Return a new string, where the content inside range is replaced with replacement

Parameters:

self - The string to act on

range - The range which will be replaced

replacement - The replacement string

Returns:

The result string

stringByReplacingPercentEscapesUsingEncoding

public static String stringByReplacingPercentEscapesUsingEncoding(String self,
                                                                  int NSStringEncoding)

Creates and returns a new NSString object from the interpretation of the specified URL replacing all percent escapes with the matching characters using the specified encoding.

Parameters:

self - The URL that is used.

NSStringEncoding - The encoding used for the returned string.

Returns:

The final String.

stringByAddingPercentEscapesUsingEncoding

public static String stringByAddingPercentEscapesUsingEncoding(String self,
                                                               int NSStringEncoding)

Creates and returns a new NSString object by adding percent escapes in order to convert it to a legal URL.

Parameters:

self - The URL that is used.

NSStringEncoding - The encoding used for the returned string.

Returns:

The final String.

compare

public static int compare(String self,
                          String with,
                          int NSStringCompareOptions)

Compares the given Strings using the specified options.

Parameters:

self - The first String to be compared.

with - The second String to be compared.

NSStringCompareOptions - The option for searching the Strings.

Returns:

The result of comparing the two Strings.

See Also:

NSOrdered

componentsSeparatedByString

public static List<String> componentsSeparatedByString(String self,
                                                       String separator)

Returns a list that contains the substrings of the specified String divided by the given separator.

Parameters:

self - The initial String.

separator - The separator String.

Returns:

The list that contains the substrings of the specified String divided by the given separator.

initWithData

public static String initWithData(NSData data,
                                  int NSStringEncoding)

Returns a String that is encoded representation of the given NSData object of the specified encoding.

Parameters:

data - The NSData object to be encoded.

NSStringEncoding - The encoding used.

Returns:

The new String object.

initWithFormat

public static String initWithFormat(String format,
                                    Object... args)

Create a String based on the provided format

Parameters:

format - The iOS-type formatting

args - The possible arguments, up to 20 arguments

Returns:

The formatted String

localizedStringWithFormat

public static String localizedStringWithFormat(String format,
                                               Object... args)

Get a localized version of a formatted String using current locale

Parameters:

format - The iOS-type formatting

args - The possible arguments, up to 20 arguments

Returns:

A localized version of the formatted String

initWithFormat

public static String initWithFormat(String format,
                                    NSLocale loc,
                                    Object... args)

Get a localized version of a formatted String

Parameters:

format - The iOS-type formatting

args - The possible arguments, up to 20 arguments

loc - The preferred locale

Returns:

A localized version of the formatted String

drawAtPoint

@Deprecated
public static CGSize drawAtPoint(String self,
                                             CGPoint point,
                                             UIFont font)

Deprecated.

Draws the specified string at the specified point using the specified font.

Parameters:

self - The string that is drawn.

point - The benchmark of the text drawing.

font - The font that is used.

Returns:

The size of the string.

sizeWithFont

@Deprecated
public static CGSize sizeWithFont(String self,
                                              UIFont font)

Deprecated.

Returns the size that the specified string would have if it was depicted with the specified font.

Parameters:

self - The String for which the size is requested.

font - The font that the String would have.

Returns:

The size of the String.

sizeWithFont

@Deprecated
public static CGSize sizeWithFont(String self,
                                              UIFont font,
                                              CGSize size,
                                              int NSLineBreakMode)

Deprecated.

Returns the size that the specified string would have if it was depicted with the specified font and line attributes on a single line.

Parameters:

self - The String for which the size is requested.

font - The font that the String would have.

size - The initial size of the String.

NSLineBreakMode - The line break options in order to compute the new size.

Returns:

The size that the String would have.

writeToFile

public static boolean writeToFile(String self,
                                  String path,
                                  boolean atomically,
                                  int NSStringEncoding,
                                  crossmobile.rt.StrongReference<NSError> error)

Writes the specified content to the specified file using the given encoding.

Parameters:

self - The content that will be written to the file.

path - The path of the file to which the content will be written.

atomically - FALSE if the content was written directly, TRUE if there was an auxiliary file.

NSStringEncoding - The string encoding.

error - The error that occurs in case of failure.NULL when there the error description is useless.

Returns:

TRUE if the operation was successful.