org.apache.paimon.options

Class Options

java.lang.Object

org.apache.paimon.options.Options

All Implemented Interfaces:

Serializable

@Public
 @ThreadSafe
public class Options
extends Object
implements Serializable

Options which stores key/value pairs.

Since:

0.4.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Options() Creates a new empty configuration.
Options(Map<String,String> map) Creates a new configuration that is initialized with the options of the given map.
Options(Map<String,String> map1, Map<String,String> map2) Creates a new configuration that is initialized with the options of the given two maps.

Method Summary

Modifier and Type	Method and Description
void	addAllToProperties(Properties props) Adds all entries in these options to the given Properties.
boolean	contains(ConfigOption<?> configOption) Checks whether there is an entry for the given config option.
boolean	containsKey(String key)
boolean	equals(Object o)
static Options	fromMap(Map<String,String> map)
<T> T	get(ConfigOption<T> option)
String	get(String key)
boolean	getBoolean(String key, boolean defaultValue)
double	getDouble(String key, double defaultValue)
int	getInteger(String key, int defaultValue)
long	getLong(String key, long defaultValue)
<T> Optional<T>	getOptional(ConfigOption<T> option)
String	getString(ConfigOption<String> option)
String	getString(String key, String defaultValue)
int	hashCode()
Set<String>	keySet()
void	remove(String key)
Options	removePrefix(String prefix)
<T> Options	set(ConfigOption<T> option, T value)
void	set(String key, String value)
void	setInteger(String key, int value)
void	setString(String key, String value) Adds the given key/value pair to the configuration object.
Map<String,String>	toMap()

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options()

Creates a new empty configuration.

Options

public Options(Map<String,String> map)

Creates a new configuration that is initialized with the options of the given map.

Options

public Options(Map<String,String> map1,
               Map<String,String> map2)

Creates a new configuration that is initialized with the options of the given two maps.

Method Detail

fromMap

public static Options fromMap(Map<String,String> map)

setString

public void setString(String key,
                      String value)

Adds the given key/value pair to the configuration object.

Parameters:

key - the key of the key/value pair to be added

value - the value of the key/value pair to be added

set

public void set(String key,
                String value)

set

public <T> Options set(ConfigOption<T> option,
                       T value)

get

public <T> T get(ConfigOption<T> option)

get

public String get(String key)

getOptional

public <T> Optional<T> getOptional(ConfigOption<T> option)

contains

public boolean contains(ConfigOption<?> configOption)

Checks whether there is an entry for the given config option.

Parameters:

configOption - The configuration option

Returns:

true if a valid (current or deprecated) key of the config option is stored, false otherwise

keySet

public Set<String> keySet()

toMap

public Map<String,String> toMap()

removePrefix

public Options removePrefix(String prefix)

remove

public void remove(String key)

containsKey

public boolean containsKey(String key)

addAllToProperties

public void addAllToProperties(Properties props)

Adds all entries in these options to the given Properties.

getString

public String getString(ConfigOption<String> option)

getBoolean

public boolean getBoolean(String key,
                          boolean defaultValue)

getInteger

public int getInteger(String key,
                      int defaultValue)

getDouble

public double getDouble(String key,
                        double defaultValue)

getString

public String getString(String key,
                        String defaultValue)

setInteger

public void setInteger(String key,
                       int value)

getLong

public long getLong(String key,
                    long defaultValue)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object