String (JanosRuntime JavaDOC)

java.lang.Object
- java.lang.String

public final class String
extends Object

Constructor Summary

Constructors
Constructor and Description
`String()` String
`String(byte[] abyte0)`
`String(byte[] abyte0, int i)` Deprecated. Method String is deprecated ?
`String(byte[] abyte0, int i, int j)`
`String(byte[] abyte0, int i, int j, int k)`
`String(byte[] bytes, int ofs, int len, String name)` Convert byte[] to String using the appropriate byte encoding (UTF8 or ISO8859_1)/
`String(byte[] bytes, String name)` Convert byte[] to String using the appropriate byte encoding (UTF8 or ISO8859_1)
`String(char[] ac)`
`String(char[] ac, int i, int j)`
`String(String s)`
`String(StringBuffer stringbuffer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`char`	`charAt(int i)`
`int`	`compareTo(String s)`
`String`	`concat(String s)`
`boolean`	`contains(int ch)` Determines if the character (ch) appears in a string.
`boolean`	`contains(String needle)` Determines if a string (haystack) contains an occurrence of another string (needle).
`static String`	`copyValueOf(char[] ac)`
`static String`	`copyValueOf(char[] ac, int i, int j)`
`boolean`	`endsWith(String s)`
`boolean`	`equals(Object obj)` Compares two Objects for equality.
`boolean`	`equalsIgnoreCase(String s)`
`static String`	`format(String args, Object... params)` Returns a formatted string using the specified format string and arguments.
`byte[]`	`getBytes()`
`void`	`getBytes(int start, int stop, byte[] abyte, int ofs)`
`byte[]`	`getBytes(String s)`
`void`	`getChars(int i, int j, char[] ac, int k)`
`int`	`hashCode()` Returns a hash code value for the object.
`static int`	`indexOf(char[] arr, int ofs, int len, String str, int idx)` Returns index of the supplied (@code String) segment in the character array subset defined by an offset and length.
`int`	`indexOf(int i)`
`int`	`indexOf(String s)`
`int`	`indexOf(String s, int i)`
`int`	`indexOfChar(int i, int j)`
`String`	`intern()` Returns a canonical representation for the string object.
`static int`	`lastIndexOf(char[] arr, int ofs, int len, String str, int idx)` Returns the last index of the supplied (@code String) segment in the character array subset defined by an offset and length.
`int`	`lastIndexOf(int i)`
`int`	`lastIndexOf(int i, int j)`
`int`	`lastIndexOf(String s)`
`int`	`lastIndexOf(String s, int i)`
`int`	`length()`
`boolean`	`regionMatches(boolean flag, int i, String s, int j, int k)`
`boolean`	`regionMatches(int i, String s, int j, int k)`
`String`	`replace(char c, char c1)`
`boolean`	`startsWith(String s)`
`boolean`	`startsWith(String s, int i)`
`String`	`substring(int i)`
`String`	`substring(int i, int j)`
`char[]`	`toCharArray()`
`String`	`toLowerCase()`
`String`	`toLowerCase(Locale locale)`
`String`	`toString()` Returns a string representation of the object.
`String`	`toUpperCase()`
`String`	`toUpperCase(Locale locale)`
`String`	`trim()`
`static String`	`valueOf(boolean flag)`
`static String`	`valueOf(char c)`
`static String`	`valueOf(char[] ac)`
`static String`	`valueOf(char[] ac, int i, int j)`
`static String`	`valueOf(double d)`
`static String`	`valueOf(float f)`
`static String`	`valueOf(int i)`
`static String`	`valueOf(long l)`
`static String`	`valueOf(Object obj)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - String
```
public String()
```
    String
  - String
```
public String(String s)
```
    Parameters:
    
    s - ?
  - String
```
public String(StringBuffer stringbuffer)
```
    Parameters:
    
    stringbuffer - ?
  - String
```
public String(byte[] abyte0)
```
    Parameters:
    
    abyte0 - ?
  - String
```
public String(byte[] abyte0,
              int i)
```
    Deprecated. Method String is deprecated ?
    
    Parameters:
    
    abyte0 - ?
    
    i - ?
  - String
```
public String(byte[] abyte0,
              int i,
              int j)
```
    Parameters:
    
    abyte0 - ?
    
    i - ?
    
    j - ?
  - String
```
public String(byte[] abyte0,
              int i,
              int j,
              int k)
```
    Parameters:
    
    abyte0 - ?
    
    i - ?
    
    j - ?
    
    k - ?
  - String
```
public String(byte[] bytes,
              int ofs,
              int len,
              String name)
       throws UnsupportedEncodingException
```
    Convert byte[] to String using the appropriate byte encoding (UTF8 or ISO8859_1)/
    
    Parameters:
    
    bytes - byte array to convert
    
    ofs - starting offset in the array
    
    len - length of the byte array
    
    name - encoding name
    
    Throws:
    
    UnsupportedEncodingException - if the encoding is not supported
  - String
```
public String(byte[] bytes,
              String name)
       throws UnsupportedEncodingException
```
    Convert byte[] to String using the appropriate byte encoding (UTF8 or ISO8859_1)
    
    Parameters:
    
    bytes - byte array to convert
    
    name - encoding name
    
    Throws:
    
    UnsupportedEncodingException - ?
  - String
```
public String(char[] ac)
```
    Parameters:
    
    ac - ?
  - String
```
public String(char[] ac,
              int i,
              int j)
```
    Parameters:
    
    ac - ?
    
    i - ?
    
    j - ?
- Method Detail
  - charAt
```
public char charAt(int i)
```
    Parameters:
    
    i - ?
    
    Returns:
    
    ?
  - compareTo
```
public int compareTo(String s)
```
    Parameters:
    
    s - ?
    
    Returns:
    
    ?
  - concat
```
public String concat(String s)
```
    Parameters:
    
    s - ?
    
    Returns:
    
    ?
  - copyValueOf
```
public static String copyValueOf(char[] ac)
```
    Parameters:
    
    ac - ?
    
    Returns:
    
    ?
  - copyValueOf
```
public static String copyValueOf(char[] ac,
                                 int i,
                                 int j)
```
    Parameters:
    
    ac - ?
    
    i - ?
    
    j - ?
    
    Returns:
    
    ?
  - endsWith
```
public boolean endsWith(String s)
```
    Parameters:
    
    s - ?
    
    Returns:
    
    ?
  - equals
```
public boolean equals(Object obj)
```
    Description copied from class: Object
    Compares two Objects for equality.
    The equals method implements an equivalence relation:
    - It is reflexive: for any reference value x, x.equals(x) should return true.
    - It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    - It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    - It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false.
    - For any reference value x, x.equals(null) should return false.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
    
    See Also:
    
    Boolean.hashCode(), Hashtable
  - equalsIgnoreCase
```
public boolean equalsIgnoreCase(String s)
```
    Parameters:
    
    s - ?
    
    Returns:
    
    ?
  - getBytes
```
public byte[] getBytes()
```
    Returns:
    
    ?
  - getBytes
```
public void getBytes(int start,
                     int stop,
                     byte[] abyte,
                     int ofs)
```
    Parameters:
    
    start - ?
    
    stop - ?
    
    abyte - ?
    
    ofs - ?
  - getBytes
```
public byte[] getBytes(String s)
                throws UnsupportedEncodingException
```
    Parameters:
    
    s - ?
    
    Returns:
    
    ?
    
    Throws:
    
    UnsupportedEncodingException - ?
  - getChars
```
public void getChars(int i,
                     int j,
                     char[] ac,
                     int k)
```
    Parameters:
    
    i - ?
    
    j - ?
    
    ac - ?
    
    k - ?
  - hashCode
```
public int hashCode()
```
    Description copied from class: Object
    Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.
    The general contract of hashCode is:
    - Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer. This integer need not remain consistent from one execution of an application to another execution of the same application.
    - If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.
    
    See Also:
    
    Object.equals(java.lang.Object), Hashtable
  - contains
```
public boolean contains(String needle)
```
    Determines if a string (haystack) contains an occurrence of another string (needle). Searches for the presence of needle. Requires JANOS v1.4 or later.
    
    Parameters:
    
    needle - String that we are looking for.
    
    Returns:
    
    TRUE if (@code indexOF(needle)) return an index and not -1.
  - contains
```
public boolean contains(int ch)
```
    Determines if the character (ch) appears in a string. Requires JANOS v1.4 or later.
    
    Parameters:
    
    ch - Character to search for.
    
    Returns:
    
    TRUE if the string contains at least one instance of the character (ch).
  - indexOf
```
public int indexOf(int i)
```
    Parameters:
    
    i - ?
    
    Returns:
    
    ?
  - indexOfChar
```
public int indexOfChar(int i,
                       int j)
```
    Parameters:
    
    i - ?
    
    j - ?
    
    Returns:
    
    ?
  - indexOf
```
public int indexOf(String s)
```
    Parameters:
    
    s - ?
    
    Returns:
    
    ?
  - indexOf
```
public int indexOf(String s,
                   int i)
```
    Parameters:
    
    s - ?
    
    i - ?
    
    Returns:
    
    ?
  - indexOf
```
public static int indexOf(char[] arr,
                          int ofs,
                          int len,
                          String str,
                          int idx)
```
    Returns index of the supplied (@code String) segment in the character array subset defined by an offset and length.
    
    Parameters:
    
    arr - character array to be searched
    
    ofs - offset in the character array at which to begin searching
    
    len - length of the search segment
    
    str - the (@code String) to find
    
    idx - index in (@code String) at which the search string begins
    
    Returns:
    
    index of the string (-1 if not present)
  - intern
```
public String intern()
```
    Returns a canonical representation for the string object.
    If s and t are strings such that s.equals(t), it is guaranteed that
    s.intern() == t.intern().
    
    Returns:
    
    a string that has the same contents as this string, but is guaranteed to be from a pool of unique strings.
  - lastIndexOf
```
public int lastIndexOf(int i)
```
    Parameters:
    
    i - ?
    
    Returns:
    
    ?
  - lastIndexOf
```
public int lastIndexOf(int i,
                       int j)
```
    Parameters:
    
    i - ?
    
    j - ?
    
    Returns:
    
    ?
  - lastIndexOf
```
public int lastIndexOf(String s)
```
    Parameters:
    
    s - ?
    
    Returns:
    
    ?
  - lastIndexOf
```
public int lastIndexOf(String s,
                       int i)
```
    Parameters:
    
    s - ?
    
    i - ?
    
    Returns:
    
    ?
  - lastIndexOf
```
public static int lastIndexOf(char[] arr,
                              int ofs,
                              int len,
                              String str,
                              int idx)
```
    Returns the last index of the supplied (@code String) segment in the character array subset defined by an offset and length.
    
    Parameters:
    
    arr - character array to be searched
    
    ofs - offset in the character array at which to begin searching
    
    len - length of the search segment
    
    str - the (@code String) to find
    
    idx - index in (@code String) at which the search string begins
    
    Returns:
    
    last index of the string (-1 if not present)
  - length
```
public int length()
```
    Returns:
    
    ?
  - regionMatches
```
public boolean regionMatches(int i,
                             String s,
                             int j,
                             int k)
```
    Parameters:
    
    i - ?
    
    s - ?
    
    j - ?
    
    k - ?
    
    Returns:
    
    ?
  - regionMatches
```
public boolean regionMatches(boolean flag,
                             int i,
                             String s,
                             int j,
                             int k)
```
    Parameters:
    
    flag - ?
    
    i - ?
    
    s - ?
    
    j - ?
    
    k - ?
    
    Returns:
    
    ?
  - replace
```
public String replace(char c,
                      char c1)
```
    Parameters:
    
    c - ?
    
    c1 - ?
    
    Returns:
    
    ?
  - startsWith
```
public boolean startsWith(String s)
```
    Parameters:
    
    s - ?
    
    Returns:
    
    ?
  - startsWith
```
public boolean startsWith(String s,
                          int i)
```
    Parameters:
    
    s - ?
    
    i - ?
    
    Returns:
    
    ?
  - substring
```
public String substring(int i)
```
    Parameters:
    
    i - ?
    
    Returns:
    
    ?
  - substring
```
public String substring(int i,
                        int j)
```
    Parameters:
    
    i - ?
    
    j - ?
    
    Returns:
    
    ?
  - toCharArray
```
public char[] toCharArray()
```
    Returns:
    
    ?
  - toLowerCase
```
public String toLowerCase()
```
    Returns:
    
    ?
  - toLowerCase
```
public String toLowerCase(Locale locale)
```
    Parameters:
    
    locale - ?
    
    Returns:
    
    ?
  - toString
```
public String toString()
```
    Description copied from class: Object
    
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.
  - toUpperCase
```
public String toUpperCase()
```
    Returns:
    
    ?
  - toUpperCase
```
public String toUpperCase(Locale locale)
```
    Parameters:
    
    locale - ?
    
    Returns:
    
    ?
  - trim
```
public String trim()
```
    Returns:
    
    ?
  - valueOf
```
public static String valueOf(char c)
```
    Parameters:
    
    c - ?
    
    Returns:
    
    ?
  - valueOf
```
public static String valueOf(double d)
```
    Parameters:
    
    d - ?
    
    Returns:
    
    ?
  - valueOf
```
public static String valueOf(float f)
```
    Parameters:
    
    f - ?
    
    Returns:
    
    ?
  - valueOf
```
public static String valueOf(int i)
```
    Parameters:
    
    i - ?
    
    Returns:
    
    ?
  - valueOf
```
public static String valueOf(long l)
```
    Parameters:
    
    l - ?
    
    Returns:
    
    ?
  - valueOf
```
public static String valueOf(Object obj)
```
    Parameters:
    
    obj - ?
    
    Returns:
    
    ?
  - valueOf
```
public static String valueOf(boolean flag)
```
    Parameters:
    
    flag - ?
    
    Returns:
    
    ?
  - valueOf
```
public static String valueOf(char[] ac)
```
    Parameters:
    
    ac - ?
    
    Returns:
    
    ?
  - valueOf
```
public static String valueOf(char[] ac,
                             int i,
                             int j)
```
    Parameters:
    
    ac - ?
    
    i - ?
    
    j - ?
    
    Returns:
    
    ?
  - format
```
public static String format(String args,
                            Object... params)
```
    Returns a formatted string using the specified format string and arguments.
    
    Parameters:
    
    args - A format string
    
    params - Arguments referenced by the format specifiers in the format string.
    
    Returns:
    
    A formatted string

Class String

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

String

String

String

String

String

String

String

String

String

String

String

Method Detail

charAt

compareTo

concat

copyValueOf

copyValueOf

endsWith

equals

equalsIgnoreCase

getBytes

getBytes

getBytes

getChars

hashCode

contains

contains

indexOf

indexOfChar

indexOf

indexOf

indexOf

intern

lastIndexOf

lastIndexOf

lastIndexOf

lastIndexOf

lastIndexOf

length

regionMatches

regionMatches

replace

startsWith

startsWith

substring

substring

toCharArray

toLowerCase

toLowerCase

toString

toUpperCase

toUpperCase

trim

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

format