org.apache.hadoop.hive.metastore.properties

Class PropertySchema

java.lang.Object

org.apache.hadoop.hive.metastore.properties.PropertySchema

All Implemented Interfaces:

Serializable

public class PropertySchema
extends Object
implements Serializable

A property map schema pertaining to a given object type (cluster, database, table).

A schema declares the properties that can be set, their type and their eventual default value.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected UUID	digest The uuid.
static PropertySchema	NONE A default schema that treats all properties as string.
protected Map<String,PropertyType<?>>	properties The properties and their types, may be empty, never null.
protected Map<String,Object>	values The properties default value.

Constructor Summary

Constructors

Constructor and Description
PropertySchema(DataInput input) The deserializing constructor.

Method Summary

Modifier and Type	Method and Description
boolean	declareProperty(String name, PropertyType<?> type) Declares a new property.
boolean	declareProperty(String name, PropertyType<?> type, Object defaultValue) Declares a new property.
boolean	equals(Object o)
void	forEach(BiConsumer<String,PropertyType<?>> action) Perform an action on all properties.
Object	getDefaultValue(String name) Gets the default value for a property.
UUID	getDigest() Gets this property schema digest.
String	getName()
PropertyType<?>	getPropertyType(String name) Gets the type for a given property.
int	getVersionNumber()
int	hashCode()
boolean	removeProperty(String name) For testing purpose, removes a property from this schema.
void	setDefaultValue(String name, Object value) Sets the default value for a property.
String	toString()
void	write(DataOutput output) The serializing write method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

digest

protected transient volatile UUID digest

The uuid.

properties

protected final transient Map<String,PropertyType<?>> properties

The properties and their types, may be empty, never null.

values

protected transient Map<String,Object> values

The properties default value.

NONE

public static final PropertySchema NONE

A default schema that treats all properties as string.

Constructor Detail

PropertySchema

public PropertySchema(DataInput input)
               throws IOException

The deserializing constructor.

Called by reflection through SerializationProxy

Parameters:

input - the input stream

Throws:

IOException - if IO fail

Method Detail

write

public void write(DataOutput output)
           throws IOException

The serializing write method.

Parameters:

output - the output stream

Throws:

IOException - if IO fail

getName

public String getName()

Returns:

this schema name

getVersionNumber

public int getVersionNumber()

Returns:

this schema version number

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getDigest

public UUID getDigest()

Gets this property schema digest.

Returns:

the digest uuid

forEach

public void forEach(BiConsumer<String,PropertyType<?>> action)

Perform an action on all properties.

Parameters:

action - the action

getPropertyType

public PropertyType<?> getPropertyType(String name)

Gets the type for a given property.

Parameters:

name - the property name

Returns:

the property type or null of not set

getDefaultValue

public Object getDefaultValue(String name)

Gets the default value for a property.

Parameters:

name - the property name

Returns:

the default value or null if not set

setDefaultValue

public void setDefaultValue(String name,
                            Object value)

Sets the default value for a property.

Parameters:

name - the property name

value - the default value to set

declareProperty

public boolean declareProperty(String name,
                               PropertyType<?> type)

Declares a new property.

Parameters:

name - the property name

type - the property type

Returns:

true if property is successfully declared, false if it was already declared

Throws:

IllegalArgumentException - if a property with the same name but a different type has already been declared

declareProperty

public boolean declareProperty(String name,
                               PropertyType<?> type,
                               Object defaultValue)

Declares a new property.

Parameters:

name - the property name

type - the property type

defaultValue - the default property value

Returns:

true if property is successfully declared, false if it was already declared

Throws:

IllegalArgumentException - if a property with the same name but a different type has already been declared

removeProperty

public boolean removeProperty(String name)

For testing purpose, removes a property from this schema.

Parameters:

name - the property name

Returns:

true if the property was successfully removed, false otherwise