org.codice.ddf.admin.configurator.impl

Class PropertyOperation.Actions

java.lang.Object

org.codice.ddf.admin.configurator.impl.PropertyOperation.Actions

All Implemented Interfaces:

PropertyActions

Enclosing class:

PropertyOperation

public static class PropertyOperation.Actions
extends Object
implements PropertyActions

Constructor Summary

Constructors

Constructor and Description
Actions()

Method Summary

Modifier and Type	Method and Description
PropertyOperation	create(Path propFile, Map<String,String> configs) Creates a handler for persisting property file changes to a new property file.
PropertyOperation	delete(Path propFile) Creates a handler for deleting a property file.
Map<String,String>	getProperties(Path propFile) Gets the current key:value pairs set in the given property file.
PropertyOperation	update(Path propFile, Map<String,String> configs, boolean keepIfNotPresent) Creates a handler for persisting property file changes to an existing property file.

Methods inherited from class java.lang.Object

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

Constructor Detail

Actions

public Actions()

Method Detail

create

public PropertyOperation create(Path propFile,
                                Map<String,String> configs)
                         throws ConfiguratorException

Description copied from interface: PropertyActions

Creates a handler for persisting property file changes to a new property file.

Specified by:

create in interface PropertyActions

Parameters:

propFile - the property file to be created

configs - map of key:value pairs to be written to the property file

Returns:

instance of this class

Throws:

ConfiguratorException - if an error occurs creating the operator

delete

public PropertyOperation delete(Path propFile)
                         throws ConfiguratorException

Description copied from interface: PropertyActions

Creates a handler for deleting a property file.

Specified by:

delete in interface PropertyActions

Parameters:

propFile - the property file to be deleted

Returns:

instance of this class

Throws:

ConfiguratorException - if an error occurs creating the operator

update

public PropertyOperation update(Path propFile,
                                Map<String,String> configs,
                                boolean keepIfNotPresent)
                         throws ConfiguratorException

Description copied from interface: PropertyActions

Creates a handler for persisting property file changes to an existing property file.

Specified by:

update in interface PropertyActions

Parameters:

propFile - the property file to be updated

configs - map of key:value pairs to be written to the property file

keepIfNotPresent - if true, any keys in the current property file that are not in the configs map will be left with their initial values; if false, they will be removed from the file

Returns:

instance of this class

Throws:

ConfiguratorException - if an error occurs creating the operator

getProperties

public Map<String,String> getProperties(Path propFile)
                                 throws ConfiguratorException

Description copied from interface: PropertyActions

Gets the current key:value pairs set in the given property file.

Specified by:

getProperties in interface PropertyActions

Parameters:

propFile - the property file to query

Returns:

the current set of key:value pairs

Throws:

ConfiguratorException - if there is an error reading the state