CharBuf (boon 0.17 API)

java.lang.Object
- java.io.Writer
- - java.io.PrintWriter
  - - org.boon.primitive.CharBuf

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable, CharSequence
```
public class CharBuf
extends PrintWriter
implements CharSequence
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected char[]`	`buffer`
`protected int`	`capacity`
`protected static int`	`DOUBLE_QUOTE`
`protected static int`	`ESCAPE`
`protected static int`	`FORWARD_SLASH`
`protected static int`	`LETTER_B`
`protected static int`	`LETTER_F`
`protected static int`	`LETTER_N`
`protected static int`	`LETTER_R`
`protected static int`	`LETTER_T`
`protected static int`	`LETTER_U`
`protected int`	`location`

Fields inherited from class java.io.PrintWriter
out

Fields inherited from class java.io.Writer
lock

Constructor Summary

Constructors
Modifier Constructor and Description

protected CharBuf()

CharBuf(byte[] bytes)

CharBuf(char[] buffer)

protected CharBuf(int capacity)

Constructors
Modifier	Constructor and Description
`protected`	`CharBuf()`
	`CharBuf(byte[] bytes)`
	`CharBuf(char[] buffer)`
`protected`	`CharBuf(int capacity)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`_len(int location)`
`CharBuf`	`add(boolean b)`
`CharBuf`	`add(byte i)`
`CharBuf`	`add(byte[] chars)`
`CharBuf`	`add(byte[] bytes, int start, int end)`
`CharBuf`	`add(char ch)`
`CharBuf`	`add(char[] chars)`
`CharBuf`	`add(char[] chars, int length)`
`CharBuf`	`add(CharSequence str)`
`CharBuf`	`add(double d)`
`CharBuf`	`add(float d)`
`CharBuf`	`add(int i)`
`CharBuf`	`add(long l)`
`CharBuf`	`add(Object str)`
`CharBuf`	`add(short i)`
`CharBuf`	`add(String str)`
`void`	`addAsUTF(byte[] value)`
`CharBuf`	`addBigDecimal(BigDecimal key)`
`CharBuf`	`addBigInteger(BigInteger key)`
`CharBuf`	`addBoolean(boolean b)`
`CharBuf`	`addByte(byte i)`
`CharBuf`	`addChar(byte i)`
`CharBuf`	`addChar(char ch)`
`CharBuf`	`addChar(int i)`
`CharBuf`	`addChar(short i)`
`CharBuf`	`addChars(char[] chars)`
`CharBuf`	`addCurrency(Currency key)`
`CharBuf`	`addDouble(double d)`
`CharBuf`	`addDouble(Double key)`
`CharBuf`	`addFloat(float d)`
`CharBuf`	`addFloat(Float key)`
`CharSequence`	`addHex(int decoded)` Turn a single bytes into two hex character representation.
`CharBuf`	`addInt(int i)`
`CharBuf`	`addInt(Integer key)`
`CharBuf`	`addJsonEscapedString(char[] charArray)`
`CharBuf`	`addJsonFieldName(char[] chars)`
`CharBuf`	`addJsonFieldName(String str)`
`CharBuf`	`addLine()`
`CharBuf`	`addLine(char[] chars)`
`CharBuf`	`addLine(CharSequence str)`
`CharBuf`	`addLine(Object str)`
`CharBuf`	`addLine(String str)`
`CharBuf`	`addLong(long l)`
`CharBuf`	`addLong(Long key)`
`void`	`addNull()`
`CharBuf`	`addObject(Object object)`
`CharBuf`	`addQuoted(char[] chars)`
`CharBuf`	`addQuoted(String str)`
`CharBuf`	`addShort(short i)`
`CharBuf`	`addString(String str)`
`PrintWriter`	`append(CharSequence csq)`
`CharBuf`	`asJsonString(String jsonString)`
`byte`	`byteValue()`
`char`	`charAt(int index)`
`void`	`close()`
`static CharBuf`	`create(char[] buffer)`
`static CharBuf`	`create(int capacity)`
`static CharBuf`	`createCharBuf()`
`static CharBuf`	`createCharBuf(int capacity)`
`static CharBuf`	`createExact(int capacity)`
`static CharBuf`	`createFromUTF8Bytes(byte[] buffer)`
`CharBuf`	`decodeJsonString(byte[] bytes, int start, int to)`
`CharBuf`	`decodeJsonString(char[] chars)`
`CharBuf`	`decodeJsonString(char[] chars, int start, int to)`
`CharBuf`	`decodeJsonStringAscii(byte[] bytes, int start, int to)`
`void`	`display()`
`double`	`doubleValue()`
`protected static int`	`encodeNibbleToHexAsciiCharByte(int nibble)` Turns a single nibble into an ascii HEX digit.
`void`	`ensure(int i)`
`boolean`	`equals(Object o)`
`float`	`floatValue()`
`void`	`flush()`
`int`	`hashCode()`
`CharBuf`	`indent(int i)`
`void`	`init()`
`int`	`intValue()`
`void`	`jsonDate(long millis)`
`int`	`len()`
`int`	`length()`
`long`	`longValue()`
`CharBuf`	`multiply(char c, int len)`
`CharBuf`	`multiply(CharSequence str, int len)`
`void`	`print(boolean b)` Prints a boolean value.
`void`	`print(char c)` Prints a character.
`void`	`print(char[] s)` Prints an array of characters.
`void`	`print(double d)` Prints a double-precision floating-point number.
`void`	`print(float f)` Prints a floating-point number.
`void`	`print(int i)` Prints an integer.
`void`	`print(long l)` Prints a long integer.
`void`	`print(Object obj)` Prints an object.
`void`	`print(String s)` Prints a string.
`PrintWriter`	`printf(Locale l, String format, Object... args)` A convenience method to write a formatted string to this writer using the specified format string and arguments.
`PrintWriter`	`printf(String format, Object... args)` A convenience method to write a formatted string to this writer using the specified format string and arguments.
`void`	`println()` Terminates the current line by writing the line separator string.
`void`	`println(boolean x)` Prints a boolean value and then terminates the line.
`void`	`println(char x)` Prints a character and then terminates the line.
`void`	`println(char[] x)` Prints an array of characters and then terminates the line.
`void`	`println(double x)` Prints a double-precision floating-point number and then terminates the line.
`void`	`println(float x)` Prints a floating-point number and then terminates the line.
`void`	`println(int x)` Prints an integer and then terminates the line.
`void`	`println(long x)` Prints a long integer and then terminates the line.
`void`	`println(Object object)` Prints a String and then terminates the line.
`void`	`println(String message)` Prints an Object and then terminates the line.
`void`	`puts(Object... messages)`
`char[]`	`readForRecycle()`
`void`	`recycle()`
`void`	`removeLastChar()`
`short`	`shortValue()`
`CharSequence`	`subSequence(int start, int end)`
`char[]`	`toCharArray()`
`String`	`toDebugString()`
`Number`	`toIntegerWrapper()`
`String`	`toString()`
`String`	`toStringAndRecycle()`
`void`	`write(char[] cbuf, int off, int len)`

Methods inherited from class java.io.PrintWriter
append, append, checkError, clearError, format, format, setError, write, write, write, write

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

- Field Detail
  - capacity
```
protected int capacity
```
  - location
```
protected int location
```
  - buffer
```
protected char[] buffer
```
  - DOUBLE_QUOTE
```
protected static final int DOUBLE_QUOTE
```
    See Also:
    Constant Field Values
  - ESCAPE
```
protected static final int ESCAPE
```
    See Also:
    Constant Field Values
  - LETTER_N
```
protected static final int LETTER_N
```
    See Also:
    Constant Field Values
  - LETTER_U
```
protected static final int LETTER_U
```
    See Also:
    Constant Field Values
  - LETTER_T
```
protected static final int LETTER_T
```
    See Also:
    Constant Field Values
  - LETTER_R
```
protected static final int LETTER_R
```
    See Also:
    Constant Field Values
  - LETTER_B
```
protected static final int LETTER_B
```
    See Also:
    Constant Field Values
  - LETTER_F
```
protected static final int LETTER_F
```
    See Also:
    Constant Field Values
  - FORWARD_SLASH
```
protected static final int FORWARD_SLASH
```
    See Also:
    Constant Field Values
- Constructor Detail
  - CharBuf
```
public CharBuf(char[] buffer)
```
  - CharBuf
```
public CharBuf(byte[] bytes)
```
  - CharBuf
```
protected CharBuf(int capacity)
```
  - CharBuf
```
protected CharBuf()
```
- Method Detail
  - createExact
```
public static CharBuf createExact(int capacity)
```
  - create
```
public static CharBuf create(int capacity)
```
  - createCharBuf
```
public static CharBuf createCharBuf(int capacity)
```
  - createCharBuf
```
public static CharBuf createCharBuf()
```
  - create
```
public static CharBuf create(char[] buffer)
```
  - createFromUTF8Bytes
```
public static CharBuf createFromUTF8Bytes(byte[] buffer)
```
  - write
```
public void write(char[] cbuf,
         int off,
         int len)
```
    Overrides:
    
    write in class PrintWriter
  - flush
```
public void flush()
```
    Specified by:
    
    flush in interface Flushable
    
    Overrides:
    
    flush in class PrintWriter
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class PrintWriter
  - init
```
public void init()
```
  - add
```
public final CharBuf add(Object str)
```
  - add
```
public final CharBuf add(String str)
```
  - add
```
public final CharBuf add(CharSequence str)
```
  - addString
```
public final CharBuf addString(String str)
```
  - addObject
```
public final CharBuf addObject(Object object)
```
  - add
```
public final CharBuf add(int i)
```
  - addInt
```
public final CharBuf addInt(int i)
```
  - addInt
```
public final CharBuf addInt(Integer key)
```
  - add
```
public final CharBuf add(boolean b)
```
  - addBoolean
```
public final CharBuf addBoolean(boolean b)
```
  - add
```
public final CharBuf add(byte i)
```
  - addByte
```
public final CharBuf addByte(byte i)
```
  - add
```
public final CharBuf add(short i)
```
  - addShort
```
public final CharBuf addShort(short i)
```
  - add
```
public final CharBuf add(long l)
```
  - add
```
public final CharBuf add(double d)
```
  - addDouble
```
public final CharBuf addDouble(double d)
```
  - addDouble
```
public final CharBuf addDouble(Double key)
```
  - add
```
public final CharBuf add(float d)
```
  - addFloat
```
public final CharBuf addFloat(float d)
```
  - addFloat
```
public final CharBuf addFloat(Float key)
```
  - addChar
```
public final CharBuf addChar(byte i)
```
  - addChar
```
public final CharBuf addChar(int i)
```
  - addChar
```
public final CharBuf addChar(short i)
```
  - addChar
```
public final CharBuf addChar(char ch)
```
  - add
```
public final CharBuf add(char ch)
```
  - addLine
```
public CharBuf addLine(String str)
```
  - addLine
```
public CharBuf addLine(Object str)
```
  - addLine
```
public CharBuf addLine()
```
  - addLine
```
public CharBuf addLine(char[] chars)
```
  - addLine
```
public CharBuf addLine(CharSequence str)
```
  - add
```
public CharBuf add(char[] chars)
```
  - addChars
```
public final CharBuf addChars(char[] chars)
```
  - addQuoted
```
public final CharBuf addQuoted(char[] chars)
```
  - asJsonString
```
public final CharBuf asJsonString(String jsonString)
```
  - addJsonEscapedString
```
public final CharBuf addJsonEscapedString(char[] charArray)
```
  - addJsonFieldName
```
public final CharBuf addJsonFieldName(String str)
```
  - addJsonFieldName
```
public final CharBuf addJsonFieldName(char[] chars)
```
  - addQuoted
```
public final CharBuf addQuoted(String str)
```
  - add
```
public CharBuf add(char[] chars,
          int length)
```
  - add
```
public CharBuf add(byte[] chars)
```
  - add
```
public CharBuf add(byte[] bytes,
          int start,
          int end)
```
  - length
```
public int length()
```
    Specified by:
    
    length in interface CharSequence
  - charAt
```
public char charAt(int index)
```
    Specified by:
    
    charAt in interface CharSequence
  - subSequence
```
public CharSequence subSequence(int start,
                       int end)
```
    Specified by:
    
    subSequence in interface CharSequence
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface CharSequence
    
    Overrides:
    
    toString in class Object
  - toDebugString
```
public String toDebugString()
```
  - toStringAndRecycle
```
public String toStringAndRecycle()
```
  - len
```
public int len()
```
  - toCharArray
```
public char[] toCharArray()
```
  - _len
```
public void _len(int location)
```
  - readForRecycle
```
public char[] readForRecycle()
```
  - recycle
```
public void recycle()
```
  - doubleValue
```
public double doubleValue()
```
  - floatValue
```
public float floatValue()
```
  - intValue
```
public int intValue()
```
  - longValue
```
public long longValue()
```
  - byteValue
```
public byte byteValue()
```
  - shortValue
```
public short shortValue()
```
  - toIntegerWrapper
```
public Number toIntegerWrapper()
```
  - addAsUTF
```
public void addAsUTF(byte[] value)
```
  - addNull
```
public final void addNull()
```
  - removeLastChar
```
public void removeLastChar()
```
  - addBigDecimal
```
public CharBuf addBigDecimal(BigDecimal key)
```
  - addBigInteger
```
public CharBuf addBigInteger(BigInteger key)
```
  - addLong
```
public final CharBuf addLong(long l)
```
  - addLong
```
public final CharBuf addLong(Long key)
```
  - addCurrency
```
public CharBuf addCurrency(Currency key)
```
  - addHex
```
public CharSequence addHex(int decoded)
```
    Turn a single bytes into two hex character representation.
    
    Parameters:
    decoded - the byte to serializeObject.
  - encodeNibbleToHexAsciiCharByte
```
protected static int encodeNibbleToHexAsciiCharByte(int nibble)
```
    Turns a single nibble into an ascii HEX digit.
    
    Parameters:
    nibble - the nibble to serializeObject.
    
    Returns:
    the encoded nibble (1/2 byte).
  - decodeJsonString
```
public final CharBuf decodeJsonString(char[] chars)
```
  - decodeJsonString
```
public final CharBuf decodeJsonString(char[] chars,
                       int start,
                       int to)
```
  - decodeJsonString
```
public final CharBuf decodeJsonString(byte[] bytes,
                       int start,
                       int to)
```
  - decodeJsonStringAscii
```
public final CharBuf decodeJsonStringAscii(byte[] bytes,
                            int start,
                            int to)
```
  - ensure
```
public void ensure(int i)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - multiply
```
public CharBuf multiply(char c,
               int len)
```
  - multiply
```
public CharBuf multiply(CharSequence str,
               int len)
```
  - puts
```
public void puts(Object... messages)
```
  - println
```
public void println(String message)
```
    Prints an Object and then terminates the line. This method calls at first String.valueOf(x) to get the printed object's string value, then behaves as though it invokes print(String) and then println().
    
    Overrides:
    
    println in class PrintWriter
    
    Parameters:
    message - The Object to be printed.
  - println
```
public void println(Object object)
```
    Prints a String and then terminates the line. This method behaves as though it invokes print(String) and then println().
    
    Overrides:
    
    println in class PrintWriter
    
    Parameters:
    object - the String value to be printed
  - indent
```
public CharBuf indent(int i)
```
  - jsonDate
```
public void jsonDate(long millis)
```
  - append
```
public PrintWriter append(CharSequence csq)
```
    Specified by:
    
    append in interface Appendable
    
    Overrides:
    
    append in class PrintWriter
  - print
```
public void print(boolean b)
```
    Prints a boolean value. The string produced by String.valueOf(boolean) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the PrintWriter.write(int) method.
    
    Overrides:
    
    print in class PrintWriter
    
    Parameters:
    b - The boolean to be printed
  - print
```
public void print(char c)
```
    Prints a character. The character is translated into one or more bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the PrintWriter.write(int) method.
    
    Overrides:
    
    print in class PrintWriter
    
    Parameters:
    c - The char to be printed
  - print
```
public void print(int i)
```
    Prints an integer. The string produced by String.valueOf(int) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the PrintWriter.write(int) method.
    
    Overrides:
    
    print in class PrintWriter
    
    Parameters:
    i - The int to be printed
    See Also:
    Integer.toString(int)
  - print
```
public void print(long l)
```
    Prints a long integer. The string produced by String.valueOf(long) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the PrintWriter.write(int) method.
    
    Overrides:
    
    print in class PrintWriter
    
    Parameters:
    l - The long to be printed
    See Also:
    Long.toString(long)
  - print
```
public void print(float f)
```
    Prints a floating-point number. The string produced by String.valueOf(float) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the PrintWriter.write(int) method.
    
    Overrides:
    
    print in class PrintWriter
    
    Parameters:
    f - The float to be printed
    See Also:
    Float.toString(float)
  - print
```
public void print(double d)
```
    Prints a double-precision floating-point number. The string produced by String.valueOf(double) is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the PrintWriter.write(int) method.
    
    Overrides:
    
    print in class PrintWriter
    
    Parameters:
    d - The double to be printed
    See Also:
    Double.toString(double)
  - print
```
public void print(char[] s)
```
    Prints an array of characters. The characters are converted into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the PrintWriter.write(int) method.
    
    Overrides:
    
    print in class PrintWriter
    
    Parameters:
    s - The array of chars to be printed
    
    Throws:
    
    NullPointerException - If s is null
  - print
```
public void print(String s)
```
    Prints a string. If the argument is null then the string "null" is printed. Otherwise, the string's characters are converted into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the PrintWriter.write(int) method.
    
    Overrides:
    
    print in class PrintWriter
    
    Parameters:
    s - The String to be printed
  - print
```
public void print(Object obj)
```
    Prints an object. The string produced by the String.valueOf(Object) method is translated into bytes according to the platform's default character encoding, and these bytes are written in exactly the manner of the PrintWriter.write(int) method.
    
    Overrides:
    
    print in class PrintWriter
    
    Parameters:
    obj - The Object to be printed
    See Also:
    Object.toString()
  - println
```
public void println()
```
    Terminates the current line by writing the line separator string. The line separator string is defined by the system property line.separator, and is not necessarily a single newline character ('\n').
    
    Overrides:
    
    println in class PrintWriter
  - println
```
public void println(boolean x)
```
    Prints a boolean value and then terminates the line. This method behaves as though it invokes print(boolean) and then println().
    
    Overrides:
    
    println in class PrintWriter
    
    Parameters:
    x - the boolean value to be printed
  - println
```
public void println(char x)
```
    Prints a character and then terminates the line. This method behaves as though it invokes print(char) and then println().
    
    Overrides:
    
    println in class PrintWriter
    
    Parameters:
    x - the char value to be printed
  - println
```
public void println(int x)
```
    Prints an integer and then terminates the line. This method behaves as though it invokes print(int) and then println().
    
    Overrides:
    
    println in class PrintWriter
    
    Parameters:
    x - the int value to be printed
  - println
```
public void println(long x)
```
    Prints a long integer and then terminates the line. This method behaves as though it invokes print(long) and then println().
    
    Overrides:
    
    println in class PrintWriter
    
    Parameters:
    x - the long value to be printed
  - println
```
public void println(float x)
```
    Prints a floating-point number and then terminates the line. This method behaves as though it invokes print(float) and then println().
    
    Overrides:
    
    println in class PrintWriter
    
    Parameters:
    x - the float value to be printed
  - println
```
public void println(double x)
```
    Prints a double-precision floating-point number and then terminates the line. This method behaves as though it invokes print(double) and then println().
    
    Overrides:
    
    println in class PrintWriter
    
    Parameters:
    x - the double value to be printed
  - println
```
public void println(char[] x)
```
    Prints an array of characters and then terminates the line. This method behaves as though it invokes print(char[]) and then println().
    
    Overrides:
    
    println in class PrintWriter
    
    Parameters:
    x - the array of char values to be printed
  - printf
```
public PrintWriter printf(String format,
                 Object... args)
```
    A convenience method to write a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer.
    An invocation of this method of the form out.printf(format, args) behaves in exactly the same way as the invocation
```
     out.format(format, args) 
```
    Overrides:
    
    printf in class PrintWriter
    
    Parameters:
    format - A format string as described in Format string syntax.
    args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by The Java™ Virtual Machine Specification. The behaviour on a null argument depends on the conversion.
    
    Returns:
    This writer
    
    Throws:
    
    NullPointerException - If the format is null
  - printf
```
public PrintWriter printf(Locale l,
                 String format,
                 Object... args)
```
    A convenience method to write a formatted string to this writer using the specified format string and arguments. If automatic flushing is enabled, calls to this method will flush the output buffer.
    An invocation of this method of the form out.printf(l, format, args) behaves in exactly the same way as the invocation
```
     out.format(l, format, args) 
```
    Overrides:
    
    printf in class PrintWriter
    
    Parameters:
    l - The locale to apply during formatting. If l is null then no localization is applied.
    format - A format string as described in Format string syntax.
    args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by The Java™ Virtual Machine Specification. The behaviour on a null argument depends on the conversion.
    
    Returns:
    This writer
    
    Throws:
    
    NullPointerException - If the format is null
    Since:
    
    1.5
  - display
```
public void display()
```

Class CharBuf

Field Summary

Fields inherited from class java.io.PrintWriter

Fields inherited from class java.io.Writer

Constructor Summary

Method Summary

Methods inherited from class java.io.PrintWriter

Methods inherited from class java.lang.Object

Field Detail

capacity

location

buffer

DOUBLE_QUOTE

ESCAPE

LETTER_N

LETTER_U

LETTER_T

LETTER_R

LETTER_B

LETTER_F

FORWARD_SLASH

Constructor Detail

CharBuf

CharBuf

CharBuf

CharBuf

Method Detail

createExact

create

createCharBuf

createCharBuf

create

createFromUTF8Bytes

write

flush

close

init

add

add

add

addString

addObject

add

addInt

addInt

add

addBoolean

add

addByte

add

addShort

add

add

addDouble

addDouble

add

addFloat

addFloat

addChar

addChar

addChar

addChar

add

addLine

addLine

addLine

addLine

addLine

add

addChars

addQuoted

asJsonString

addJsonEscapedString

addJsonFieldName

addJsonFieldName

addQuoted

add

add

add

length