alluxio.conf

Class AlluxioProperties

java.lang.Object

alluxio.conf.AlluxioProperties

@NotThreadSafe
public class AlluxioProperties
extends Object

Provides the source of truth of property values and a unified abstraction to put and get properties, hiding the difference of accessing user-specified properties, the default properties (known at construction time) and the extension properties (known at runtime). This class is supposed to handle the ordering and priority of properties from different sources, whereas the Configuration class is supposed to handle the type conversion on top of the source of truth of the properties. For a given property key, the order of preference of its value is (from highest to lowest) (1) runtime config (2) system properties, (3) properties in the specified file (site-properties), (4) default property values.

Constructor Summary

Constructors

Constructor and Description
AlluxioProperties() Constructs a new instance of Alluxio properties.
AlluxioProperties(AlluxioProperties alluxioProperties)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all existing user-specified properties.
AlluxioProperties	copy() Makes a copy of the backing properties and returns them in a new object.
Set<Map.Entry<PropertyKey,String>>	entrySet()
void	forEach(java.util.function.BiConsumer<? super PropertyKey,? super String> action) Iterates over all the key value pairs and performs the given action.
String	get(PropertyKey key)
Source	getSource(PropertyKey key)
String	hash()
boolean	isSet(PropertyKey key) Checks if there is a value set for the given key.
boolean	isSetByUser(PropertyKey key)
Set<PropertyKey>	keySet()
void	merge(Map<?,?> properties, Source source) Merges the current configuration properties with new properties.
void	put(PropertyKey key, String value, Source source) Puts the key value pair specified by users.
void	remove(PropertyKey key) Remove the value set for key.
void	set(PropertyKey key, String value) Puts the key value pair specified by users.
void	setSource(PropertyKey key, Source source) Sets the source for a given key.
Set<PropertyKey>	userKeySet()

Methods inherited from class java.lang.Object

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

Constructor Detail

AlluxioProperties

public AlluxioProperties()

Constructs a new instance of Alluxio properties.

AlluxioProperties

public AlluxioProperties(AlluxioProperties alluxioProperties)

Parameters:

alluxioProperties - properties to copy

Method Detail

get

@Nullable
public String get(PropertyKey key)

Parameters:

key - the key to query

Returns:

the value, or null if the key has no value set

clear

public void clear()

Clears all existing user-specified properties.

put

public void put(PropertyKey key,
                String value,
                Source source)

Puts the key value pair specified by users.

Parameters:

key - key to put

value - value to put

source - the source of this value for the key

set

public void set(PropertyKey key,
                String value)

Puts the key value pair specified by users.

Parameters:

key - key to put

value - value to put

merge

public void merge(Map<?,?> properties,
                  Source source)

Merges the current configuration properties with new properties. If a property exists both in the new and current configuration, the one from the new configuration wins if its priority is higher or equal than the existing one.

Parameters:

properties - the source Properties to be merged

source - the source of the the properties (e.g., system property, default and etc)

remove

public void remove(PropertyKey key)

Remove the value set for key.

Parameters:

key - key to remove

isSet

public boolean isSet(PropertyKey key)

Checks if there is a value set for the given key.

Parameters:

key - the key to check

Returns:

true if there is value for the key, false otherwise

isSetByUser

public boolean isSetByUser(PropertyKey key)

Parameters:

key - the key to check

Returns:

true if there is a value for the key set by user, false otherwise even when there is a default value for the key

entrySet

public Set<Map.Entry<PropertyKey,String>> entrySet()

Returns:

the entry set of all Alluxio property key and value pairs (value can be null)

keySet

public Set<PropertyKey> keySet()

Returns:

the key set of all Alluxio property

userKeySet

public Set<PropertyKey> userKeySet()

Returns:

the key set of user set properties

forEach

public void forEach(java.util.function.BiConsumer<? super PropertyKey,? super String> action)

Iterates over all the key value pairs and performs the given action.

Parameters:

action - the operation to perform on each key value pair

copy

public AlluxioProperties copy()

Makes a copy of the backing properties and returns them in a new object.

Returns:

a copy of the current properties

setSource

public void setSource(PropertyKey key,
                      Source source)

Sets the source for a given key.

Parameters:

key - property key

source - the source

getSource

public Source getSource(PropertyKey key)

Parameters:

key - property key

Returns:

the source of the key

hash

public String hash()

Returns:

the current hash of the properties