Package org.apache.accumulo.core.data

Class KeyBuilder

java.lang.Object

org.apache.accumulo.core.data.KeyBuilder

public class KeyBuilder
extends Object

A builder used to build Keys by defining their components. The rules are:

• All components of the Key are optional except the row
• Components not explicitly set default to empty byte array except the timestamp which defaults to Long.MAX_VALUE
• The column qualifier can only be set if the column family has been set first
• The column visibility can only be set if at least the column family has been set first

The builder supports three types of components: byte[], Text and CharSequence. CharSequences must be UTF-8 encoded. The builder is mutable and not thread safe.

Since:

2.0

See Also:

Key

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KeyBuilder.Build	Base Builder interface which can be used to set the Key timestamp and delete marker and to build the Key.
static interface	KeyBuilder.ColumnFamilyStep	Builder step used to set the columnFamily part of the Key.
static interface	KeyBuilder.ColumnQualifierStep	Builder step used to set the column qualifier part of the Key.
static interface	KeyBuilder.ColumnVisibilityStep	Builder step used to set the column visibility part of the Key.
static interface	KeyBuilder.RowStep	Builder step used to set the row part of the Key.

Constructor Summary

Constructors

Constructor	Description
KeyBuilder()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyBuilder

public KeyBuilder()