Package de.fraunhofer.iosb.ilt.configurable

Interface ContentConfigEditor<T>

Type Parameters:

T - The type of object returned by getValue.

All Superinterfaces:

ConfigEditor<T>

All Known Implementing Classes:

EditorMap

public interface ContentConfigEditor<T>
extends ConfigEditor<T>

Interface defining configuration editors suited to set configured content.

Author:

Fraunhofer IOSB

Field Summary

Fields inherited from interface de.fraunhofer.iosb.ilt.configurable.ConfigEditor

DEFAULT_PROFILE_NAME

Method Summary

Modifier and Type	Method	Description
Object	getValue(String name)	Get the value set for the given option.
boolean	isOptionSet(String name)	Checks if the given option is set.
void	setContentsOn(Object target)	For any configurable content, tries to set the configured value on the target object.

Methods inherited from interface de.fraunhofer.iosb.ilt.configurable.ConfigEditor

canEdit, getConfig, getDescription, getGuiFactoryFx, getGuiFactorySwing, getJsonRootSchema, getJsonSchema, getLabel, getValue, initFor, initFor, isDefault, setConfig, setDescription, setLabel, setProfile, setValue

Method Detail

setContentsOn

void setContentsOn(Object target)
            throws ConfigurationException

For any configurable content, tries to set the configured value on the target object.

Parameters:

target - The target instance to use.

Throws:

ConfigurationException - if any of the values could not be loaded.

isOptionSet

boolean isOptionSet(String name)

Checks if the given option is set. For mandatory options this should always return true.

Parameters:

name - The option to check.

Returns:

true if the option is set, false otherwise.

getValue

Object getValue(String name)
         throws ConfigurationException

Get the value set for the given option.

Parameters:

name - The option to check.

Returns:

The value of the given option.

Throws:

ConfigurationException - If the given option can not be retrieved because the configuration passed to the editor was incorrect.