Package org.aeonbits.owner

Interface Accessible

All Superinterfaces:

Config, Serializable

public interface Accessible
extends Config

Allows a Config object to access the contents of the properties, providing utility methods to perform consequent operations.

Example:

     public interface MyConfig extends Config, Accessible {
         int someProperty();
     }

     public void doSomething() {
         MyConfig cfg = ConfigFactory.create(MyConfig.class);
         cfg.list(System.out);
     }
 

These methods will print the list of properties, see Properties.list(java.io.PrintStream) and Properties.list(java.io.PrintWriter).

Since:

1.0.4

Author:

Luigi R. Viggiano

Nested Class Summary

Nested classes/interfaces inherited from interface org.aeonbits.owner.Config

Config.ConverterClass, Config.DecryptorClass, Config.DefaultValue, Config.DisableableFeature, Config.DisableFeature, Config.EncryptedValue, Config.HotReload, Config.HotReloadType, Config.Key, Config.LoadPolicy, Config.LoadType, Config.PreprocessorClasses, Config.Separator, Config.Sources, Config.TokenizerClass

Method Summary

Modifier and Type	Method	Description
void	fill(Map map)	Fills the given Map with the properties contained by this object.
String	getProperty(String key)	Searches for the property with the specified key in this property list.
String	getProperty(String key, String defaultValue)	Searches for the property with the specified key in this property list.
void	list(PrintStream out)	Prints this property list out to the specified output stream.
void	list(PrintWriter out)	Prints this property list out to the specified output stream.
Set<String>	propertyNames()	Returns a set of keys in this property list including distinct keys in the default property list if a key of the same name has not already been found from the main properties list.
void	store(OutputStream out, String comments)	Stores the underlying properties into an OutputStream.
void	storeToXML(OutputStream os, String comment)	Emits an XML document representing all of the properties contained in this table.

Method Detail

list

void list(PrintStream out)

Prints this property list out to the specified output stream. This method is useful for debugging.

Parameters:

out - an output stream.

Throws:

ClassCastException - if any key in this property list is not a string.

Since:

1.0.4

See Also:

Properties.list(java.io.PrintStream)

list

void list(PrintWriter out)

Prints this property list out to the specified output stream. This method is useful for debugging.

Parameters:

out - an output stream.

Throws:

ClassCastException - if any key in this property list is not a string.

Since:

1.0.4

See Also:

Properties.list(java.io.PrintWriter)

store

void store(OutputStream out,
           String comments)
    throws IOException

Stores the underlying properties into an OutputStream.

Notice that method Properties.store(java.io.Writer, String) is not implemented since it's not available in JDK 1.5 (while the target of this library is Java 1.5+).

Parameters:

out - an output stream.

comments - a description of the property list.

Throws:

IOException - if writing this property list to the specified output stream throws an IOException.

Since:

1.0.4

See Also:

Properties.store(java.io.OutputStream, String)

fill

void fill(Map map)

Fills the given Map with the properties contained by this object.
This is useful to extract the content of the config object into a Map.

Notice that you can specify a properties object as parameter instead of a map, since Properties implements the Map interface.

Parameters:

map - the Map to fill.

Since:

1.0.9

getProperty

String getProperty(String key)

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns null if the property is not found.

Parameters:

key - the property key.

Returns:

the value in this property list with the specified key value.

Since:

1.0.4

See Also:

Properties.getProperty(String)

getProperty

String getProperty(String key,
                   String defaultValue)

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found.

Parameters:

key - the property key.

defaultValue - a default value.

Returns:

the value in this property list with the specified key value.

Since:

1.0.4

See Also:

Properties.getProperty(String, String)

storeToXML

void storeToXML(OutputStream os,
                String comment)
         throws IOException

Emits an XML document representing all of the properties contained in this table.

An invocation of this method of the form props.storeToXML(os, comment) behaves in exactly the same way as the invocation props.storeToXML(os, comment, "UTF-8");.

Parameters:

os - the output stream on which to emit the XML document.

comment - a description of the property list, or null if no comment is desired.

Throws:

IOException - if writing to the specified output stream results in an IOException.

NullPointerException - if os is null.

ClassCastException - if this Properties object contains any keys or values that are not Strings.

Since:

1.0.5

propertyNames

Set<String> propertyNames()

Returns a set of keys in this property list including distinct keys in the default property list if a key of the same name has not already been found from the main properties list.

The returned set is not backed by the Properties object. Changes to this Properties are not reflected in the set, or vice versa.

Returns:

a set of keys in this property list, including the keys in the default property list.

Throws:

ClassCastException - if any key in this property list is not a string.

Since:

1.0.5

See Also:

Properties.defaults, Properties.stringPropertyNames(), Properties.propertyNames()