Package io.deephaven.configuration

Class ParsedProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

io.deephaven.configuration.ParsedProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class ParsedProperties
extends Properties

Class for reading in a customized properties file, applying only the locally-relevant properties and keeping track of which properties may not be further modified. Maintains the ordering of the properties from the input file.

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor	Description
ParsedProperties()	A constructor that starts with no existing scoped or final properties.
ParsedProperties(boolean ignoreScopes)	A constructor that starts with no existing scoped or final properties.

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	contains(Object value)
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Enumeration<Object>	elements()
@NotNull Set	entrySet()
boolean	equals(Object o)
Object	get(@NotNull Object key)
Map<String,List<PropertyHistory>>	getLineNumbers()	A mapping from each property name to the file and location where the property came from.
String	getProperty(String key)
boolean	isEmpty()
Enumeration	keys()
@NotNull Set	keySet()
void	list(PrintStream out)
void	list(PrintWriter out)
void	load(InputStream stream)	Load the properties from the specified InputStream, ignoring any directives that do not match the current context.
void	load(String fileName)	Load the properties from the specified file, ignoring any directives that do not match the current context.
Object	put(Object key, Object value)	Determine whether a property is final or not, and only allow the update if it is not already final.
void	putAll(Map<?,?> t)
Object	remove(Object key)	Remove a non-final property from the collection.
Object	setProperty(String key, String value)	Determine whether a property is final or not, and only allow the update if it is not already final.
int	size()
@NotNull Collection	values()

Methods inherited from class java.util.Properties

clone, compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, getProperty, hashCode, load, loadFromXML, merge, propertyNames, putIfAbsent, rehash, remove, replace, replace, replaceAll, save, store, store, storeToXML, storeToXML, storeToXML, stringPropertyNames, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ParsedProperties

public ParsedProperties()

A constructor that starts with no existing scoped or final properties.

ParsedProperties

public ParsedProperties(boolean ignoreScopes)

A constructor that starts with no existing scoped or final properties.

Parameters:

ignoreScopes - True if this parser should ignore scope restrictions, false otherwise. Used by the PropertyInspector when checking whether required or disallowed properties are present.

Method Details

getLineNumbers

public Map<String,List<PropertyHistory>> getLineNumbers()

A mapping from each property name to the file and location where the property came from. This is public so that we can use this in a property inspector to get the full story about what properties exist and where those properties were defined.

Returns:

The current map

putAll

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

Specified by:

putAll in interface Map<Object,Object>

Overrides:

putAll in class Properties

clear

public void clear()

Specified by:

clear in interface Map<Object,Object>

Overrides:

clear in class Properties

contains

public boolean contains(Object value)

Overrides:

contains in class Properties

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<Object,Object>

Overrides:

containsKey in class Properties

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<Object,Object>

Overrides:

containsValue in class Properties

elements

public Enumeration<Object> elements()

Overrides:

elements in class Properties

entrySet

@NotNull
public @NotNull Set entrySet()

Specified by:

entrySet in interface Map<Object,Object>

Overrides:

entrySet in class Properties

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<Object,Object>

Overrides:

equals in class Properties

get

public Object get(@NotNull
 @NotNull Object key)

Specified by:

get in interface Map<Object,Object>

Overrides:

get in class Properties

getProperty

public String getProperty(String key)

Overrides:

getProperty in class Properties

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Object,Object>

Overrides:

isEmpty in class Properties

keys

public Enumeration keys()

Overrides:

keys in class Properties

keySet

@NotNull
public @NotNull Set keySet()

Specified by:

keySet in interface Map<Object,Object>

Overrides:

keySet in class Properties

list

public void list(PrintStream out)

Overrides:

list in class Properties

list

public void list(PrintWriter out)

Overrides:

list in class Properties

size

public int size()

Specified by:

size in interface Map<Object,Object>

Overrides:

size in class Properties

values

@NotNull
public @NotNull Collection values()

Specified by:

values in interface Map<Object,Object>

Overrides:

values in class Properties

load

public void load(InputStream stream)
          throws IOException

Load the properties from the specified InputStream, ignoring any directives that do not match the current context. Automatically closes the stream when the last line has been processed.

Overrides:

load in class Properties

Parameters:

stream - The open stream providing a view into the data to be parsed.

Throws:

IOException - If the stream cannot be read at some point.

put

public Object put(Object key,
 Object value)

Determine whether a property is final or not, and only allow the update if it is not already final.

Specified by:

put in interface Map<Object,Object>

Overrides:

put in class Properties

Parameters:

key - The name of the property to set a value for.

value - The value of the property being set.

Returns:

The previous value of the property being set, or null if it had no previous value.

remove

public Object remove(Object key)

Remove a non-final property from the collection. Attempting to remove a final property will cause a ConfigurationException to be thrown.

Specified by:

remove in interface Map<Object,Object>

Overrides:

remove in class Properties

Parameters:

key - The name of the property to be removed.

Returns:

The value of the property, if it existed.

setProperty

public Object setProperty(String key,
 String value)

Determine whether a property is final or not, and only allow the update if it is not already final. This should not be called from within the load operation for this class.

Overrides:

setProperty in class Properties

Parameters:

key - The name of the property to set a value for.

value - The value of the property being set.

Returns:

The previous value of the property being set, or null if it had no previous value.

load

public void load(String fileName)
          throws IOException,
ConfigurationException

Load the properties from the specified file, ignoring any directives that do not match the current context. Directories may be specified, including relative paths, but the '~' operator is not supported.

Loads the fileName via PropertyInputStreamLoader.

Parameters:

fileName - The resource or file to load.

Throws:

IOException - if the property stream cannot be processed

ConfigurationException - if the property stream cannot be opened