Package org.apache.camel.util

Class OrderedLocationProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

org.apache.camel.util.OrderedLocationProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public final class OrderedLocationProperties
extends Properties

An OrderedProperties that also keeps track from which location the properties are sourced from, and default values. This can be used to track all the various sources for configuration that a Camel application uses (properties file, ENV variables, hardcoded in java, spring-boot, quarkus, camel-k modeline, camel-yaml-dsl etc. Important: Use the put method that takes location as argument to store location information, and the put method that takes default value as argument to store default value information.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor	Description
OrderedLocationProperties()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()
void	clear()
protected Object	doPut(String key, String value)
Set<Map.Entry<Object,Object>>	entrySet()
Object	get(Object key)
Object	getDefaultValue(Object key)	Gets the default value of the property, if a default value exists
String	getLocation(Object key)	Gets the location from where the property was resolved
String	getProperty(String key)
String	getProperty(String key, String defaultValue)
boolean	isEmpty()
Enumeration<Object>	keys()
Set<Object>	keySet()
Object	put(Object key, Object value)
void	put(String location, Object key, Object value)
void	put(String location, Object key, Object value, Object defaultValue)
void	putAll(String location, Map<Object,Object> map)
void	putAll(String location, Properties properties)
void	putAll(Map<?,?> t)
void	putAll(OrderedLocationProperties other)
Object	remove(Object key)
int	size()
Set<String>	stringPropertyNames()
String	toString()
Collection<Object>	values()

Methods inherited from class java.util.Properties

clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, equals, forEach, getOrDefault, hashCode, list, list, load, load, loadFromXML, merge, propertyNames, putIfAbsent, rehash, remove, replace, replace, replaceAll, save, setProperty, store, store, storeToXML, storeToXML, storeToXML

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderedLocationProperties

public OrderedLocationProperties()

Method Detail

put

public void put(String location,
                Object key,
                Object value)

put

public void put(String location,
                Object key,
                Object value,
                Object defaultValue)

putAll

public void putAll(OrderedLocationProperties other)

putAll

public void putAll(String location,
                   Map<Object,Object> map)

putAll

public void putAll(String location,
                   Properties properties)

getLocation

public String getLocation(Object key)

Gets the location from where the property was resolved

Parameters:

key - the property key

Returns:

the location, or null if not possible to determine the location.

getDefaultValue

public Object getDefaultValue(Object key)

Gets the default value of the property, if a default value exists

Parameters:

key - the property key

Returns:

the default value, or null if not possible to determine the default value.

clear

public void clear()

Specified by:

clear in interface Map<Object,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<Object,Object>

asMap

public Map<String,Object> asMap()

put

public Object put(Object key,
                  Object value)

Specified by:

put in interface Map<Object,Object>

Overrides:

put in class Properties

doPut

protected Object doPut(String key,
                       String value)

putAll

public void putAll(Map<?,?> t)

Specified by:

putAll in interface Map<Object,Object>

Overrides:

putAll in class Properties

get

public Object get(Object key)

Specified by:

get in interface Map<Object,Object>

Overrides:

get in class Properties

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Object,Object>

Overrides:

isEmpty in class Properties

getProperty

public String getProperty(String key)

Overrides:

getProperty in class Properties

getProperty

public String getProperty(String key,
                          String defaultValue)

Overrides:

getProperty in class Properties

keys

public Enumeration<Object> keys()

Overrides:

keys in class Properties

keySet

public Set<Object> keySet()

Specified by:

keySet in interface Map<Object,Object>

Overrides:

keySet in class Properties

entrySet

public Set<Map.Entry<Object,Object>> entrySet()

Specified by:

entrySet in interface Map<Object,Object>

Overrides:

entrySet in class Properties

size

public int size()

Specified by:

size in interface Map<Object,Object>

Overrides:

size in class Properties

stringPropertyNames

public Set<String> stringPropertyNames()

Overrides:

stringPropertyNames in class Properties

values

public Collection<Object> values()

Specified by:

values in interface Map<Object,Object>

Overrides:

values in class Properties

toString

public String toString()

Overrides:

toString in class Properties