PropertyMap (Hive Standalone Metastore Common Code 4.0.0 API)

java.lang.Object
- org.apache.hadoop.hive.metastore.properties.PropertyMap

All Implemented Interfaces:

Serializable
```
public class PropertyMap
extends Object
implements Serializable
```
A property map pertaining to a given object type (cluster, database, table).
Maps follow a copy-on-write scheme gated by a dirty flag (avoid copy of a dirty map). This allows sharing their content (the inner properties map) with guaranteed isolation and thread safety.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected UUID`	`digest` The uuid.
`protected boolean`	`dirty` Whether this map is dirty which also reflects its copy-on-write state.
`static org.slf4j.Logger`	`LOGGER` The logger.
`protected Map<String,Object>`	`properties` The properties and their values; the map is cow-once.
`protected PropertySchema`	`schema` The schema for this map, describes allowed properties and their types.

Constructor Summary

Constructors
Constructor and Description
`PropertyMap(DataInput input, Function<String,PropertySchema> getSchema)` Deserialization ctor.
`PropertyMap(PropertyMap src, Map<String,Object> input)` The projection constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PropertyMap`	`copy()` A copy of this map.
`boolean`	`equals(Object o)`
`Map<String,String>`	`export()` Exports this property map as a key/value as string map.
`Map<String,String>`	`export(boolean withDefaults)` Exports this property map as a key/value as string map.
`void`	`exportToProperties(Properties javap)` Exports this map properties to java properties
`void`	`forEach(BiConsumer<? super String,Object> action)` Call action on each property name/value.
`UUID`	`getDigest()` Gets this property set digest.
`Object`	`getProperty(String name)` Gets the value of a property.
`Object`	`getPropertyValue(String name)` Gets the value of a property.
`protected PropertyType<?>`	`getTypeOf(String name)`
`int`	`hashCode()`
`void`	`importFromProperties(Properties javap)` Import key value pairs from java properties.
`boolean`	`isDirty()`
`boolean`	`isDropped()`
`boolean`	`isEmpty()`
`Object`	`putProperty(String name, Object value)` Sets the value of a property.
`Object`	`removeProperty(String name)` Removes a property from this map.
`void`	`setClean()` Clears the inner dirty flag.
`int`	`size()`
`void`	`write(DataOutput out)` The Serialization method.

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

- Field Detail
  - LOGGER
```
public static final org.slf4j.Logger LOGGER
```
    The logger.
  - schema
```
protected final transient PropertySchema schema
```
    The schema for this map, describes allowed properties and their types.
  - digest
```
protected transient volatile UUID digest
```
    The uuid.
  - properties
```
protected transient Map<String,Object> properties
```
    The properties and their values; the map is cow-once.
  - dirty
```
protected transient boolean dirty
```
    Whether this map is dirty which also reflects its copy-on-write state.
- Constructor Detail
  - PropertyMap
```
public PropertyMap(PropertyMap src,
                   Map<String,Object> input)
```
    The projection constructor.
    This copies an instance and sets key/value pairs at the same time.
    
    Note that the resulting map is not dirty.
    
    Parameters:
    
    src - the instance to copy
    
    input - the pairs to set
  - PropertyMap
```
public PropertyMap(DataInput input,
                   Function<String,PropertySchema> getSchema)
            throws IOException
```
    Deserialization ctor.
    Used through deserializtion through reflection by the serialization proxy.
    
    Parameters:
    
    input - the input stream
    
    Throws:
    
    IOException - if IO fail
- Method Detail
  - write
```
public void write(DataOutput out)
           throws IOException
```
    The Serialization method.
    
    Parameters:
    
    out - the output stream
    
    Throws:
    
    IOException - if IO fail
  - size
```
public int size()
```
  - isEmpty
```
public boolean isEmpty()
```
    Returns:
    
    true if any property is valued, false otherwise
  - isDirty
```
public boolean isDirty()
```
    Returns:
    
    true if some property value has changed, false otherwise
  - setClean
```
public void setClean()
```
    Clears the inner dirty flag.
    This implies the inner map becomes shareable between instances (see #copy()).
    
    This should only be called after a save()/write().
  - isDropped
```
public boolean isDropped()
```
    Returns:
    
    true if this map has been explicitly dropped, false otherwise
  - copy
```
public PropertyMap copy()
```
    A copy of this map.
    Called to avoid sharing instances from cache.
    
    Returns:
    
    a shallow copy of this map
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getTypeOf
```
protected PropertyType<?> getTypeOf(String name)
```
  - exportToProperties
```
public void exportToProperties(Properties javap)
```
    Exports this map properties to java properties
    
    Parameters:
    
    javap - the java properties
  - importFromProperties
```
public void importFromProperties(Properties javap)
```
    Import key value pairs from java properties.
    
    Parameters:
    
    javap - the java properties
  - getDigest
```
public UUID getDigest()
```
    Gets this property set digest.
    
    Returns:
    
    the digest uuid
  - putProperty
```
public Object putProperty(String name,
                          Object value)
```
    Sets the value of a property.
    
    Parameters:
    
    name - the property name
    
    value - the value
    
    Returns:
    
    the previous value or null
    
    Throws:
    
    IllegalArgumentException - if the property is not declared or the value is of an incorrect type
  - removeProperty
```
public Object removeProperty(String name)
```
    Removes a property from this map.
    
    Parameters:
    
    name - the property name
    
    Returns:
    
    the value that was set or null
  - getProperty
```
public Object getProperty(String name)
```
    Gets the value of a property.
    
    Parameters:
    
    name - the property name
    
    Returns:
    
    the property value or null if no property with that name is set
  - getPropertyValue
```
public Object getPropertyValue(String name)
```
    Gets the value of a property.
    
    Parameters:
    
    name - the property name
    
    Returns:
    
    the property value or the schema default value if not set
  - forEach
```
public void forEach(BiConsumer<? super String,Object> action)
```
    Call action on each property name/value.
    
    Parameters:
    
    action - the action to call
  - export
```
public Map<String,String> export()
```
    Exports this property map as a key/value as string map.
    
    Returns:
    
    a string.string map
  - export
```
public Map<String,String> export(boolean withDefaults)
```
    Exports this property map as a key/value as string map.
    
    Parameters:
    
    withDefaults - whether default values should be exported as well
    
    Returns:
    
    a string.string map

Class PropertyMap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

schema

digest

properties

dirty

Constructor Detail

PropertyMap

PropertyMap

Method Detail

write

size

isEmpty

isDirty

setClean

isDropped

copy

equals

hashCode

getTypeOf

exportToProperties

importFromProperties

getDigest

putProperty

removeProperty

getProperty

getPropertyValue

forEach

export

export