Text

java.lang.Object
- org.apache.hawq.pxf.service.io.Text

All Implemented Interfaces:

Writable
```
public class Text
extends java.lang.Object
implements Writable
```
This class stores text using standard UTF8 encoding. It provides methods to serialize, deserialize. The type of length is integer and is serialized using zero-compressed format.

Constructor Summary

Constructors
Constructor and Description
`Text()`
`Text(byte[] utf8)` Construct from a byte array.
`Text(java.lang.String string)` Construct from a string.
`Text(Text utf8)` Construct from another text.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(byte[] utf8, int start, int len)` Appends a range of bytes to the end of the given text.
`void`	`clear()` Clears the string to empty.
`static java.lang.String`	`decode(byte[] utf8, int start, int length)`
`static java.lang.String`	`decode(byte[] utf8, int start, int length, boolean replace)` Converts the provided byte array to a String using the UTF-8 encoding.
`static int`	`decodeVIntSize(byte value)`
`static java.nio.ByteBuffer`	`encode(java.lang.String string)` Converts the provided String to bytes using the UTF-8 encoding.
`static java.nio.ByteBuffer`	`encode(java.lang.String string, boolean replace)` Converts the provided String to bytes using the UTF-8 encoding.
`boolean`	`equals(java.lang.Object o)` Returns true iff `o` is a Text with the same contents.
`byte[]`	`getBytes()` Returns the raw bytes; however, only data up to `getLength()` is valid.
`int`	`getLength()` Returns the number of bytes in the byte array
`int`	`hashCode()`
`static boolean`	`isNegativeVInt(byte value)`
`void`	`readFields(java.io.DataInput inputStream)` deserialize
`static long`	`readVLong(java.io.DataInput stream)`
`void`	`set(byte[] utf8)` Sets to a UTF-8 byte array.
`void`	`set(byte[] utf8, int start, int len)` Sets the Text to range of bytes.
`void`	`set(java.lang.String string)` Sets to contain the contents of a string.
`void`	`set(Text other)` Copies a text.
`java.lang.String`	`toString()` Convert text back to string
`void`	`write(java.io.DataOutput out)` Serialize the fields of this object to `out`.

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

- Constructor Detail
  - Text
```
public Text()
```
  - Text
```
public Text(java.lang.String string)
```
    Construct from a string.
    
    Parameters:
    
    string - input string
  - Text
```
public Text(Text utf8)
```
    Construct from another text.
    
    Parameters:
    
    utf8 - text to copy
  - Text
```
public Text(byte[] utf8)
```
    Construct from a byte array.
    
    Parameters:
    
    utf8 - input byte array
- Method Detail
  - isNegativeVInt
```
public static boolean isNegativeVInt(byte value)
```
  - readVLong
```
public static long readVLong(java.io.DataInput stream)
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - decodeVIntSize
```
public static int decodeVIntSize(byte value)
```
  - decode
```
public static java.lang.String decode(byte[] utf8,
                                      int start,
                                      int length)
                               throws java.nio.charset.CharacterCodingException
```
    Throws:
    
    java.nio.charset.CharacterCodingException
  - decode
```
public static java.lang.String decode(byte[] utf8,
                                      int start,
                                      int length,
                                      boolean replace)
                               throws java.nio.charset.CharacterCodingException
```
    Converts the provided byte array to a String using the UTF-8 encoding. If replace is true, then malformed input is replaced with the substitution character, which is U+FFFD. Otherwise the method throws a MalformedInputException.
    
    Parameters:
    
    utf8 - UTF-8 encoded byte array
    
    start - start point
    
    length - length of array
    
    replace - whether to replace malformed input with substitution character
    
    Returns:
    
    decoded string
    
    Throws:
    
    java.nio.charset.MalformedInputException - if a malformed input is used
    
    java.nio.charset.CharacterCodingException - if the conversion failed
  - encode
```
public static java.nio.ByteBuffer encode(java.lang.String string)
                                  throws java.nio.charset.CharacterCodingException
```
    Converts the provided String to bytes using the UTF-8 encoding. If the input is malformed, invalid chars are replaced by a default value.
    
    Parameters:
    
    string - string to encode
    
    Returns:
    
    ByteBuffer: bytes stores at ByteBuffer.array() and length is ByteBuffer.limit()
    
    Throws:
    
    java.nio.charset.CharacterCodingException - if conversion failed
  - encode
```
public static java.nio.ByteBuffer encode(java.lang.String string,
                                         boolean replace)
                                  throws java.nio.charset.CharacterCodingException
```
    Converts the provided String to bytes using the UTF-8 encoding. If replace is true, then malformed input is replaced with the substitution character, which is U+FFFD. Otherwise the method throws a MalformedInputException.
    
    Parameters:
    
    string - string to encode
    
    replace - whether to replace malformed input with substitution character
    
    Returns:
    
    ByteBuffer: bytes stores at ByteBuffer.array() and length is ByteBuffer.limit()
    
    Throws:
    
    java.nio.charset.MalformedInputException - if a malformed input is used
    
    java.nio.charset.CharacterCodingException - if the conversion failed
  - getBytes
```
public byte[] getBytes()
```
    Returns the raw bytes; however, only data up to getLength() is valid.
    
    Returns:
    
    raw bytes of byte array
  - getLength
```
public int getLength()
```
    Returns the number of bytes in the byte array
    
    Returns:
    
    number of bytes in byte array
  - set
```
public void set(java.lang.String string)
```
    Sets to contain the contents of a string.
    
    Parameters:
    
    string - input string
  - set
```
public void set(byte[] utf8)
```
    Sets to a UTF-8 byte array.
    
    Parameters:
    
    utf8 - input UTF-8 byte array
  - set
```
public void set(Text other)
```
    Copies a text.
    
    Parameters:
    
    other - text object to copy.
  - set
```
public void set(byte[] utf8,
                int start,
                int len)
```
    Sets the Text to range of bytes.
    
    Parameters:
    
    utf8 - the data to copy from
    
    start - the first position of the new string
    
    len - the number of bytes of the new string
  - append
```
public void append(byte[] utf8,
                   int start,
                   int len)
```
    Appends a range of bytes to the end of the given text.
    
    Parameters:
    
    utf8 - the data to copy from
    
    start - the first position to append from utf8
    
    len - the number of bytes to append
  - clear
```
public void clear()
```
    Clears the string to empty.
  - toString
```
public java.lang.String toString()
```
    Convert text back to string
    
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    
    Object.toString()
  - write
```
public void write(java.io.DataOutput out)
           throws java.io.IOException
```
    Description copied from interface: Writable
    
    Serialize the fields of this object to out.
    
    Specified by:
    
    write in interface Writable
    
    Parameters:
    
    out - DataOutput to serialize this object into.
    
    Throws:
    
    java.io.IOException - if I/O error occurs
  - readFields
```
public void readFields(java.io.DataInput inputStream)
                throws java.io.IOException
```
    deserialize
    
    Specified by:
    
    readFields in interface Writable
    
    Parameters:
    
    inputStream - DataInput to deserialize this object from.
    
    Throws:
    
    java.io.IOException - if I/O error occurs
  - equals
```
public boolean equals(java.lang.Object o)
```
    Returns true iff o is a Text with the same contents.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class Text

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Text

Text

Text

Text

Method Detail

isNegativeVInt

readVLong

decodeVIntSize

decode

decode

encode

encode

getBytes

getLength

set

set

set

set

append

clear

toString

write

readFields

equals

hashCode