RawString (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.types.RawString

All Implemented Interfaces:

DataType<String>
```
@InterfaceAudience.Public
@InterfaceStability.Evolving
public class RawString
extends Object
implements DataType<String>
```
An DataType for interacting with values encoded using Bytes.toBytes(String). Intended to make it easier to transition away from direct use of Bytes.

See Also:
Bytes.toBytes(String), Bytes.toString(byte[]), RawStringTerminated

Field Summary

Fields
Modifier and Type Field and Description

static RawString ASCENDING

static RawString DESCENDING

protected Order order

Fields
Modifier and Type	Field and Description
`static RawString`	`ASCENDING`
`static RawString`	`DESCENDING`
`protected Order`	`order`

Constructor Summary

Constructors
Modifier Constructor and Description

protected RawString()

protected RawString(Order order)

Constructors
Modifier	Constructor and Description
`protected`	`RawString()`
`protected`	`RawString(Order order)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`decode(PositionedByteRange src)` Read an instance of `T` from the buffer `src`.
`int`	`encode(PositionedByteRange dst, String val)` Write instance `val` into buffer `dst`.
`Class<String>`	`encodedClass()` Inform consumers over what type this `DataType` operates.
`int`	`encodedLength(String val)` Inform consumers how long the encoded `byte[]` will be.
`Order`	`getOrder()` Retrieve the sort `Order` imposed by this data type, or null when natural ordering is not preserved.
`boolean`	`isNullable()` Indicates whether this instance supports encoding null values.
`boolean`	`isOrderPreserving()` Indicates whether this instance writes encoded `byte[]`'s which preserve the natural sort order of the unencoded value.
`boolean`	`isSkippable()` Indicates whether this instance is able to skip over it's encoded value.
`int`	`skip(PositionedByteRange src)` Skip `src`'s position forward over one encoded value.

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

- Field Detail
  - ASCENDING
```
public static final RawString ASCENDING
```
  - DESCENDING
```
public static final RawString DESCENDING
```
  - order
```
protected final Order order
```
- Constructor Detail
  - RawString
```
protected RawString()
```
  - RawString
```
protected RawString(Order order)
```
- Method Detail
  - isOrderPreserving
```
public boolean isOrderPreserving()
```
    Description copied from interface: DataType
    
    Indicates whether this instance writes encoded byte[]'s which preserve the natural sort order of the unencoded value.
    
    Specified by:
    
    isOrderPreserving in interface DataType<String>
    
    Returns:
    true when natural order is preserved, false otherwise.
  - getOrder
```
public Order getOrder()
```
    Description copied from interface: DataType
    
    Retrieve the sort Order imposed by this data type, or null when natural ordering is not preserved. Value is either ascending or descending. Default is assumed to be Order.ASCENDING.
    
    Specified by:
    
    getOrder in interface DataType<String>
  - isNullable
```
public boolean isNullable()
```
    Description copied from interface: DataType
    
    Indicates whether this instance supports encoding null values. This depends on the implementation details of the encoding format. All DataTypes that support null should treat null as comparing less than any non-null value for default sort ordering purposes.
    
    Specified by:
    
    isNullable in interface DataType<String>
    
    Returns:
    true when null is supported, false otherwise.
  - isSkippable
```
public boolean isSkippable()
```
    Description copied from interface: DataType
    
    Indicates whether this instance is able to skip over it's encoded value. DataTypes that are not skippable can only be used as the right-most field of a Struct.
    
    Specified by:
    
    isSkippable in interface DataType<String>
  - skip
```
public int skip(PositionedByteRange src)
```
    Description copied from interface: DataType
    
    Skip src's position forward over one encoded value.
    
    Specified by:
    
    skip in interface DataType<String>
    
    Parameters:
    src - the buffer containing the encoded value.
    
    Returns:
    number of bytes skipped.
  - encodedLength
```
public int encodedLength(String val)
```
    Description copied from interface: DataType
    
    Inform consumers how long the encoded byte[] will be.
    
    Specified by:
    
    encodedLength in interface DataType<String>
    
    Parameters:
    val - The value to check.
    
    Returns:
    the number of bytes required to encode val.a
  - encodedClass
```
public Class<String> encodedClass()
```
    Description copied from interface: DataType
    
    Inform consumers over what type this DataType operates. Useful when working with bare DataType instances.
    
    Specified by:
    
    encodedClass in interface DataType<String>
  - decode
```
public String decode(PositionedByteRange src)
```
    Description copied from interface: DataType
    
    Read an instance of T from the buffer src.
    
    Specified by:
    
    decode in interface DataType<String>
    
    Parameters:
    src - the buffer containing the encoded value.
  - encode
```
public int encode(PositionedByteRange dst,
         String val)
```
    Description copied from interface: DataType
    
    Write instance val into buffer dst.
    
    Specified by:
    
    encode in interface DataType<String>
    
    Parameters:
    dst - the buffer containing the encoded value.
    val - the value to encode onto dst.
    
    Returns:
    number of bytes written.

Class RawString

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ASCENDING

DESCENDING

order

Constructor Detail

RawString

RawString

Method Detail

isOrderPreserving

getOrder

isNullable

isSkippable

skip

encodedLength

encodedClass

decode

encode