CharRef

java.lang.Object
- de.bb.util.CharRef

All Implemented Interfaces:

java.lang.Cloneable
```
public class CharRef
extends java.lang.Object
implements java.lang.Cloneable
```
A String like class to manipulate byte arrays. The most important differences to Strings:
- CharRef share their buffer
- the current object can be modified by its functions
So the user of CharRef must handle them correctly. The result is a big speed gain in data parsing and handling.
For not yet or bad documented functions search the comment in the String class (or guess).

Constructor Summary

Constructors
Constructor and Description
`CharRef()` Initializes a newly created `CharRef` object so that it represents an empty byte sequence.
`CharRef(char[] b)` Initializes a newly created `CharRef` object so that it represents the same sequence of bytes as the argument; in other words, the newly created byte array is a copy of the argument.
`CharRef(char[] b, int _begin, int _end)` Initializes a newly created `CharRef` object so that it represents the same sequence of chars as the argument; in other words, the newly created char array is a copy of the specified part of the argument.
`CharRef(java.lang.String s)` Initializes a newly created `CharRef` object so that it represents the same sequence of bytes as the argument; in other words, the newly created byte array is a copy of the argument string.getChars().

Method Summary

Methods
Modifier and Type	Method and Description
`CharRef`	`append(CharRef o)` Append the specified `CharRef` to this `CharRef`.
`CharRef`	`append(java.lang.String s)` Append the chars of the `String` to this `CharRef`.
`void`	`assign(char[] b, int _begin, int _end)` Assigns the parameters physical char array to this object.
`void`	`assign(CharRef o)` Assigns the parameters physical char array to this object.
`int`	`charAt(int idx)` Returns the char at the specified position.
`java.lang.Object`	`clone()`
`int`	`compareTo(CharRef o)` Compares this `CharRef`'s data to another `CharRef`.
`void`	`copy(byte[] b)` Copy this data into the specified `char array`.
`void`	`copy(char[] b)` Copy this data into the specified `char array`.
`int`	`copy(char[] b, int off, int l)` Copy a part of this data into the specified `char array` at specified offset.
`boolean`	`endsWith(CharRef o)` Tests whether this BytRef ends with the specified `CharRef`.
`boolean`	`endsWith(java.lang.String s)` Tests whether this BytRef ends with the specified String.
`boolean`	`equals(java.lang.Object _o)` Compares this objects data to another object.
`boolean`	`equalsIgnoreCase(java.lang.Object _o)` Compares this objects data to another object ignoring upper and lower case.
`int`	`hashCode()` Compute a hashCode for use in Hashtable.
`int`	`indexOf(CharRef s)` Returns the first index of the specified CharRef's chars.
`int`	`indexOf(CharRef s, int off)` Returns the first index of the specified CharRef's chars.
`int`	`indexOf(int z)` Returns the first index of the specified char.
`int`	`indexOf(int z, int off)` Returns the first index of the specified char.
`int`	`indexOf(java.lang.String s)` Returns the first index of the specified String's chars.
`int`	`indexOf(java.lang.String s, int off)` Returns the first index of the specified String's chars.
`int`	`lastIndexOf(int z)` Returns the last index of the specified char.
`int`	`lastIndexOf(int z, int off)` Returns the last index of the specified char.
`int`	`length()` Return the length of this`CharRef` object.
`CharRef`	`nextLine()` Extracts the next available line from this object and returns that line as a new `BytRef` object.
`CharRef`	`nextWord()` Extracts the next available word from this object and returns that word as a new `BytRef` object.
`CharRef`	`nextWord(int delim)` Extracts the next available word from this object and returns that word as a new `BytRef` object.
`static CharRef`	`readLine(CharRef br, java.io.InputStream is)` Extracts the next line from the specified `CharRef` br.
`CharRef`	`splitLeft(int stop)` Returns a CharRef starting from 0 to stop, and removes this part from the current CharRef.
`CharRef`	`splitLeft(int start, int stop)` Returns a CharRef starting from start to stop, and removes this part from the current CharRef.
`boolean`	`startsWith(CharRef o)` Tests whether this BytRef starts with the specified `CharRef`.
`boolean`	`startsWith(java.lang.String s)` Tests whether this BytRef starts with the specified String.
`CharRef`	`substring(int a)` Returns a new BytRef object using only the specified part of this `CharRef`, up to end of this `CharRef`.
`CharRef`	`substring(int a, int z)` Returns a new BytRef object using only the specified part of this `CharRef`.
`char[]`	`toCharArray()` Returns the `CharRef`s data as a new char array.
`int`	`toInteger()` Interpret the chars as characters and convert them into an int value.
`CharRef`	`toLowerCase()` Converts upper case letters into lower case letters.
`java.lang.String`	`toString()` Returns the `CharRef`s data as a `String`.
`CharRef`	`toUpperCase()` Converts lower case letters into lower case letters.
`CharRef`	`trim()` Remove all white spaces at begin and end.
`CharRef`	`trim(int ch)` Remove all occurencies of the specified charater at begin and end.
`CharRef`	`update(java.io.InputStream is)` Update this `CharRef` with the availabledata of the specified input stream.
`void`	`writeTo(java.io.OutputStream os)` Write the chars to the specified output stream.

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

- Constructor Detail
  - CharRef
```
public CharRef()
```
    Initializes a newly created CharRef object so that it represents an empty byte sequence.
  - CharRef
```
public CharRef(java.lang.String s)
```
    Initializes a newly created CharRef object so that it represents the same sequence of bytes as the argument; in other words, the newly created byte array is a copy of the argument string.getChars().
    
    Parameters:
    s - a String.
  - CharRef
```
public CharRef(char[] b)
```
    Initializes a newly created CharRef object so that it represents the same sequence of bytes as the argument; in other words, the newly created byte array is a copy of the argument.
    
    Parameters:
    b - a char array.
  - CharRef
```
public CharRef(char[] b,
       int _begin,
       int _end)
```
    Initializes a newly created CharRef object so that it represents the same sequence of chars as the argument; in other words, the newly created char array is a copy of the specified part of the argument.
    
    Parameters:
    b - a char array.
    _begin - begin in the char array
    _end - end in the char array
- Method Detail
  - assign
```
public void assign(CharRef o)
```
    Assigns the parameters physical char array to this object.
    
    Parameters:
    o - a CharRef
  - assign
```
public void assign(char[] b,
          int _begin,
          int _end)
```
    Assigns the parameters physical char array to this object.
    
    Parameters:
    b - a char array
    _begin - begin in the char array
    _end - end in the char array
  - nextLine
```
public CharRef nextLine()
```
    Extracts the next available line from this object and returns that line as a new BytRef object. Unix and DOS EOLs are recognized correctly. MAC EOLs will fail at end of buffer!
    
    Returns:
    a new allocated CharRef object with the next line, or null if no EOL was found.
  - nextWord
```
public CharRef nextWord()
```
    Extracts the next available word from this object and returns that word as a new BytRef object. All chars < 0x20 are treated as white spaces.
    
    Returns:
    a new allocated CharRef object with the next word, or null at end of buffer.
  - nextWord
```
public CharRef nextWord(int delim)
```
    Extracts the next available word from this object and returns that word as a new BytRef object.
    
    Parameters:
    delim - the used delimiter
    
    Returns:
    a new allocated CharRef object with the next word, or null at end of buffer.
  - length
```
public int length()
```
    Return the length of thisCharRef object.
    
    Returns:
    the length of thisCharRef object
  - copy
```
public void copy(byte[] b)
```
    Copy this data into the specified char array.
    
    Parameters:
    b - a char array
  - copy
```
public void copy(char[] b)
```
    Copy this data into the specified char array.
    
    Parameters:
    b - a char array
  - copy
```
public int copy(char[] b,
       int off,
       int l)
```
    Copy a part of this data into the specified char array at specified offset.
    If there are not enough chars to copy, only the available chars are copied.
    
    Parameters:
    b - a char array
    off - the offset into b
    l - the copied length
    
    Returns:
    an int representing the real count of copied chars
  - append
```
public CharRef append(CharRef o)
```
    Append the specified CharRef to this CharRef. A new CharRef is allocated and returned, to store the concatenation of both CharRefs.
    
    Parameters:
    o - the appended CharRef
    
    Returns:
    a new CharRef object with the concatenation of both CharRefs.
  - append
```
public CharRef append(java.lang.String s)
```
    Append the chars of the String to this CharRef. A new CharRef is allocated and returned, to store the concatenation.
    
    Parameters:
    s - the appended String
    
    Returns:
    a new CharRef object with the concatenation.
  - toString
```
public java.lang.String toString()
```
    Returns the CharRefs data as a String.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    the CharRefs data as a String.
  - toCharArray
```
public char[] toCharArray()
```
    Returns the CharRefs data as a new char array.
    
    Returns:
    the CharRefs data as a new char array.
  - toUpperCase
```
public CharRef toUpperCase()
```
    Converts lower case letters into lower case letters. Convertion is done in place!
    
    Returns:
    this
  - toLowerCase
```
public CharRef toLowerCase()
```
    Converts upper case letters into lower case letters. Convertion is done in place!
    
    Returns:
    this
  - lastIndexOf
```
public int lastIndexOf(int z)
```
    Returns the last index of the specified char. Search starts et end of data. Is same as br.lastIndexOf(z, br.length()).
    
    Parameters:
    z - the searched char
    
    Returns:
    the last index of the specified char, or -1 when not found.
  - lastIndexOf
```
public int lastIndexOf(int z,
              int off)
```
    Returns the last index of the specified char.
    
    Parameters:
    z - the searched char
    off - the offset (from begin) where search starts
    
    Returns:
    the last index of the specified char, or -1 when not found.
  - indexOf
```
public int indexOf(int z)
```
    Returns the first index of the specified char. Search starts et begin of data. Is same as br.indexOf(z, 0).
    
    Parameters:
    z - the searched char
    
    Returns:
    the first index of the specified char, or -1 when not found.
  - indexOf
```
public int indexOf(int z,
          int off)
```
    Returns the first index of the specified char. Search starts et begin of data. Is same as br.indexOf(z, 0).
    
    Parameters:
    z - the searched char
    off - the offset (from begin) where search starts
    
    Returns:
    the first index of the specified char, or -1 when not found.
  - indexOf
```
public int indexOf(java.lang.String s)
```
    Returns the first index of the specified String's chars. Search starts et begin of data. Is same as br.indexOf(s, 0).
    
    Parameters:
    s - the searched String
    
    Returns:
    the first index of the specified char, or -1 when not found.
  - indexOf
```
public int indexOf(java.lang.String s,
          int off)
```
    Returns the first index of the specified String's chars. Search starts et begin of data. Is same as br.indexOf(s, 0).
    
    Parameters:
    s - the searched String
    off - the offset (from begin) where search starts
    
    Returns:
    the first index of the specified char, or -1 when not found.
  - indexOf
```
public int indexOf(CharRef s,
          int off)
```
    Returns the first index of the specified CharRef's chars. Search starts et begin of data.
    
    Parameters:
    s - the searched CharRef
    off - the offset (from begin) where search starts
    
    Returns:
    the first index of the specified char, or -1 when not found.
  - indexOf
```
public int indexOf(CharRef s)
```
    Returns the first index of the specified CharRef's chars. Search starts et begin of data. Is same as br.indexOf(s, 0).
    
    Parameters:
    s - the searched CharRef
    
    Returns:
    the first index of the specified char, or -1 when not found.
  - substring
```
public CharRef substring(int a,
                int z)
```
    Returns a new BytRef object using only the specified part of this CharRef.
    
    Parameters:
    a - begin of used chars
    z - end of used chars
    
    Returns:
    a new BytRef object using only the specified part of this CharRef.
  - substring
```
public CharRef substring(int a)
```
    Returns a new BytRef object using only the specified part of this CharRef, up to end of this CharRef.
    
    Parameters:
    a - begin of used chars
    
    Returns:
    a new BytRef object using only the specified part of this CharRef.
  - charAt
```
public int charAt(int idx)
```
    Returns the char at the specified position.
    
    Parameters:
    idx - index of the char
    
    Returns:
    the char at the specified position.
  - hashCode
```
public int hashCode()
```
    Compute a hashCode for use in Hashtable.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    a hashcode.
  - equals
```
public boolean equals(java.lang.Object _o)
```
    Compares this objects data to another object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    _o - an Object
    
    Returns:
    true, when other object is also a BytRef and it contains same data.
  - equalsIgnoreCase
```
public boolean equalsIgnoreCase(java.lang.Object _o)
```
    Compares this objects data to another object ignoring upper and lower case.
    
    Parameters:
    _o - an Object
    
    Returns:
    true, when other object is also a BytRef and it contains same data.
  - compareTo
```
public int compareTo(CharRef o)
```
    Compares this CharRef's data to another CharRef.
    
    Parameters:
    o - a CharRef object
    
    Returns:
    0, when other CharRef contains same data, -1 when this is less and 1 when this is greater then the other CharRef.
  - endsWith
```
public boolean endsWith(CharRef o)
```
    Tests whether this BytRef ends with the specified CharRef.
    
    Parameters:
    o - the other CharRef where the end is tested against
    
    Returns:
    true if this BytRef ends with the specified CharRef
  - endsWith
```
public boolean endsWith(java.lang.String s)
```
    Tests whether this BytRef ends with the specified String.
    
    Parameters:
    s - the other String where the end is tested against
    
    Returns:
    true if this BytRef ends with the specified String
  - startsWith
```
public boolean startsWith(CharRef o)
```
    Tests whether this BytRef starts with the specified CharRef.
    
    Parameters:
    o - the other CharRef where the end is tested against
    
    Returns:
    true if this BytRef starts with the specified CharRef
  - startsWith
```
public boolean startsWith(java.lang.String s)
```
    Tests whether this BytRef starts with the specified String.
    
    Parameters:
    s - the other String where the end is tested against
    
    Returns:
    true if this BytRef starts with the specified String
  - writeTo
```
public void writeTo(java.io.OutputStream os)
             throws java.io.IOException
```
    Write the chars to the specified output stream.
    
    Parameters:
    os - a output stream
    
    Throws:
    
    java.io.IOException - on io errors
  - trim
```
public CharRef trim(int ch)
```
    Remove all occurencies of the specified charater at begin and end.
    
    Parameters:
    ch - a character value
    
    Returns:
    a new CharRef with the trimed data.
  - trim
```
public CharRef trim()
```
    Remove all white spaces at begin and end.
    
    Returns:
    a new CharRef with the trimed data.
  - toInteger
```
public int toInteger()
```
    Interpret the chars as characters and convert them into an int value.
    
    Returns:
    an int value
  - update
```
public CharRef update(java.io.InputStream is)
```
    Update this CharRef with the availabledata of the specified input stream. current object's data is also updated!.
    
    Parameters:
    is - an input stream
    
    Returns:
    this on success with old and appended new data, or null on failure.
  - readLine
```
public static CharRef readLine(CharRef br,
               java.io.InputStream is)
```
    Extracts the next line from the specified CharRef br. If there is no complete line in br, the CharRef is updated using the specified input stream. This is done until a complete line is read, or br.update(is) fails.
    
    Parameters:
    br - the CharRef used as input buffer
    is - a input stream
    
    Returns:
    a new CharRef containing the next line, or null on EOS.
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - splitLeft
```
public CharRef splitLeft(int stop)
```
    Returns a CharRef starting from 0 to stop, and removes this part from the current CharRef. This CharRef contains only the content from stop to end. This is a self modifying method!!
    
    Parameters:
    stop - end position
    
    Returns:
    a CharRef as substring(0, stop) but modifies this object.
  - splitLeft
```
public CharRef splitLeft(int start,
                int stop)
```
    Returns a CharRef starting from start to stop, and removes this part from the current CharRef. This CharRef contains only the content from stop to end. This is a self modifying method!!
    
    Parameters:
    start - start position for returned CharRef
    stop - stop position for returned CharRef
    
    Returns:
    a CharRef as substring(start, stop) but modifies this object.

Class CharRef

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CharRef

CharRef

CharRef

CharRef

Method Detail

assign

assign

nextLine

nextWord

nextWord

length

copy

copy

copy

append

append

toString

toCharArray

toUpperCase

toLowerCase

lastIndexOf

lastIndexOf

indexOf

indexOf

indexOf

indexOf

indexOf

indexOf

substring

substring

charAt

hashCode

equals

equalsIgnoreCase

compareTo

endsWith

endsWith

startsWith

startsWith

writeTo

trim

trim

toInteger

update

readLine

clone

splitLeft

splitLeft