org.apache.hadoop.hbase

Class NamespaceDescriptor

java.lang.Object

org.apache.hadoop.hbase.NamespaceDescriptor

@InterfaceAudience.Public
public class NamespaceDescriptor
extends Object

Namespace POJO class. Used to represent and define namespaces. Descriptors will be persisted in an hbase table. This works since namespaces are essentially metadata of a group of tables as opposed to a more tangible container.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NamespaceDescriptor.Builder

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,String>	configuration
static NamespaceDescriptor	DEFAULT_NAMESPACE
static byte[]	DEFAULT_NAMESPACE_NAME Default namespace name.
static String	DEFAULT_NAMESPACE_NAME_STR
private String	name
static Comparator<NamespaceDescriptor>	NAMESPACE_DESCRIPTOR_COMPARATOR
static Set<String>	RESERVED_NAMESPACES
static Set<byte[]>	RESERVED_NAMESPACES_BYTES
static NamespaceDescriptor	SYSTEM_NAMESPACE
static byte[]	SYSTEM_NAMESPACE_NAME System namespace name.
static String	SYSTEM_NAMESPACE_NAME_STR

Constructor Summary

Constructors

Modifier	Constructor and Description
private	NamespaceDescriptor()
private	NamespaceDescriptor(String name)

Method Summary

Modifier and Type	Method and Description
static NamespaceDescriptor.Builder	create(NamespaceDescriptor ns)
static NamespaceDescriptor.Builder	create(String name)
Map<String,String>	getConfiguration() Getter for fetching an unmodifiable configuration map.
String	getConfigurationValue(String key) Getter for accessing the configuration value by key
String	getName()
void	removeConfiguration(String key) Remove a config setting represented by the key from the configuration map
void	setConfiguration(String key, String value) Setter for storing a configuration setting in configuration map.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_NAMESPACE_NAME

public static final byte[] SYSTEM_NAMESPACE_NAME

System namespace name.

SYSTEM_NAMESPACE_NAME_STR

public static final String SYSTEM_NAMESPACE_NAME_STR

DEFAULT_NAMESPACE_NAME

public static final byte[] DEFAULT_NAMESPACE_NAME

Default namespace name.

DEFAULT_NAMESPACE_NAME_STR

public static final String DEFAULT_NAMESPACE_NAME_STR

DEFAULT_NAMESPACE

public static final NamespaceDescriptor DEFAULT_NAMESPACE

SYSTEM_NAMESPACE

public static final NamespaceDescriptor SYSTEM_NAMESPACE

RESERVED_NAMESPACES

public static final Set<String> RESERVED_NAMESPACES

RESERVED_NAMESPACES_BYTES

public static final Set<byte[]> RESERVED_NAMESPACES_BYTES

name

private String name

configuration

private Map<String,String> configuration

NAMESPACE_DESCRIPTOR_COMPARATOR

public static final Comparator<NamespaceDescriptor> NAMESPACE_DESCRIPTOR_COMPARATOR

Constructor Detail

NamespaceDescriptor

private NamespaceDescriptor()

NamespaceDescriptor

private NamespaceDescriptor(String name)

Method Detail

getName

public String getName()

getConfigurationValue

public String getConfigurationValue(String key)

Getter for accessing the configuration value by key

getConfiguration

public Map<String,String> getConfiguration()

Getter for fetching an unmodifiable configuration map.

setConfiguration

public void setConfiguration(String key,
                             String value)

Setter for storing a configuration setting in configuration map.

Parameters:

key - Config key. Same as XML config key e.g. hbase.something.or.other.

value - String value. If null, removes the setting.

removeConfiguration

public void removeConfiguration(String key)

Remove a config setting represented by the key from the configuration map

toString

public String toString()

Overrides:

toString in class Object

create

public static NamespaceDescriptor.Builder create(String name)

create

public static NamespaceDescriptor.Builder create(NamespaceDescriptor ns)