sk.stuba.fiit.perconik.utilities.configuration

Interface Options

All Known Subinterfaces:

ActivityListener.LoggingOptions, ActivityListener.PersistenceOptions, ActivityListener.ProbingOptions, ElasticsearchOptions, PreferenceStoreOptions, UacaOptions

All Known Implementing Classes:

AbstractMapOptions, AbstractOptions, ElasticsearchOptions.View, ElasticsearchPreferences, ForwardingOptions, MapOptions, UacaOptions.View, UacaPreferences

public interface Options

TODO

Since:

1.0

Author:

Pavol Zbell

Method Summary

Modifier and Type	Method and Description
void	fromMap(java.util.Map<java.lang.String,java.lang.Object> map) Loads options from map to this options instance (optional operation).
java.lang.Object	get(java.lang.String key) Returns the value to which the specified key is mapped, or null by default.
java.lang.Object	put(java.lang.String key, java.lang.Object value) Associates the specified value with the specified key in this options instance (optional operation).
java.util.Map<java.lang.String,java.lang.Object>	toMap() Converts this options instance to map.

Method Detail

fromMap

void fromMap(java.util.Map<java.lang.String,java.lang.Object> map)

Loads options from map to this options instance (optional operation).

Clears all present options and load contents only from specified map.

Note that the implementation specifies whether this method extracts map entries or provides a view of the map.

Throws:

java.lang.UnsupportedOperationException - if the options instance does not support loading values

toMap

java.util.Map<java.lang.String,java.lang.Object> toMap()

Converts this options instance to map.

Note that the implementation specifies whether this method returns a snapshot or view of options.

Returns:

either a snapshot or view of options

put

java.lang.Object put(java.lang.String key,
                     @Nullable
                     java.lang.Object value)

Associates the specified value with the specified key in this options instance (optional operation).

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

the previous value associated with key, or null by default

Throws:

IllegalOptionException - if some property of the key or value prevents it from being stored in this options instance

java.lang.NullPointerException - if the key is null

java.lang.UnsupportedOperationException - if the options instance does not support putting new values

get

java.lang.Object get(java.lang.String key)

Returns the value to which the specified key is mapped, or null by default.

Parameters:

key - the key whose associated value is to be returned

Returns:

the value to which the specified key is mapped, or null by default

Throws:

java.lang.NullPointerException - if the key is null