Package org.apache.flink.metrics

Class MetricConfig

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

org.apache.flink.metrics.MetricConfig

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

@Public
public class MetricConfig
extends Properties

A properties class with added utility methods to extract primitives.

Values may be stored as strings via Properties.setProperty(String, String) or as native Java types via Properties.put(Object, Object) (e.g., when Flink's YAML configuration parser stores Integer, Long, or Boolean values directly). The getter methods handle both representations transparently.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor	Description
MetricConfig()

Method Summary

Modifier and Type	Method	Description
boolean	getBoolean(String key, boolean defaultValue)	Returns the value associated with the given key as a boolean.
double	getDouble(String key, double defaultValue)	Returns the value associated with the given key as a double.
float	getFloat(String key, float defaultValue)	Returns the value associated with the given key as a float.
int	getInteger(String key, int defaultValue)	Returns the value associated with the given key as an int.
long	getLong(String key, long defaultValue)	Returns the value associated with the given key as a long.
String	getString(String key, String defaultValue)	Returns the value associated with the given key as a String.

Methods inherited from class java.util.Properties

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, getProperty, getProperty, hashCode, isEmpty, keys, keySet, list, list, load, load, loadFromXML, merge, propertyNames, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, save, setProperty, size, store, store, storeToXML, storeToXML, storeToXML, stringPropertyNames, toString, values

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricConfig

public MetricConfig()

Method Detail

getString

public String getString(String key,
                        String defaultValue)

Returns the value associated with the given key as a String.

If the value is not a String, its toString() representation is returned.

Parameters:

key - the hashtable key.

defaultValue - a default value.

Returns:

the value in this property list with the specified key value as a String.

getInteger

public int getInteger(String key,
                      int defaultValue)

Returns the value associated with the given key as an int.

If the value is a Number, its intValue() is returned directly. Otherwise, the value's string representation is parsed via Integer.parseInt(String).

Parameters:

key - the hashtable key.

defaultValue - a default value.

Returns:

the value in this property list with the specified key value as an int.

getLong

public long getLong(String key,
                    long defaultValue)

Returns the value associated with the given key as a long.

If the value is a Number, its longValue() is returned directly. Otherwise, the value's string representation is parsed via Long.parseLong(String).

Parameters:

key - the hashtable key.

defaultValue - a default value.

Returns:

the value in this property list with the specified key value as a long.

getFloat

public float getFloat(String key,
                      float defaultValue)

Returns the value associated with the given key as a float.

If the value is a Number, its floatValue() is returned directly. Otherwise, the value's string representation is parsed via Float.parseFloat(String).

Parameters:

key - the hashtable key.

defaultValue - a default value.

Returns:

the value in this property list with the specified key value as a float.

getDouble

public double getDouble(String key,
                        double defaultValue)

Returns the value associated with the given key as a double.

If the value is a Number, its doubleValue() is returned directly. Otherwise, the value's string representation is parsed via Double.parseDouble(String).

Parameters:

key - the hashtable key.

defaultValue - a default value.

Returns:

the value in this property list with the specified key value as a double.

getBoolean

public boolean getBoolean(String key,
                          boolean defaultValue)

Returns the value associated with the given key as a boolean.

If the value is a Boolean, it is returned directly. Otherwise, the value's string representation is parsed via Boolean.parseBoolean(String).

Parameters:

key - the hashtable key.

defaultValue - a default value.

Returns:

the value in this property list with the specified key value as a boolean.