griffon.core

Interface MutableConfiguration

All Superinterfaces:

Configuration

All Known Implementing Classes:

DelegatingMutableConfiguration

public interface MutableConfiguration
extends Configuration

Since:

2.2.0

Author:

Andres Almiray

Method Summary

Modifier and Type	Method and Description
java.lang.Object	remove(java.lang.String key) Removes a key from this configuration.
<T> T	removeAs(java.lang.String key) Removes a key from this configuration.
<T> T	removeConverted(java.lang.String key, java.lang.Class<T> type) Removes a key from this configuration.
void	set(java.lang.String key, java.lang.Object value) Sets a key/value pair on this configuration.

Methods inherited from interface griffon.core.Configuration

asFlatMap, asProperties, asResourceBundle, containsKey, get, get, getAs, getAs, getAsBoolean, getAsBoolean, getAsDouble, getAsDouble, getAsFloat, getAsFloat, getAsInt, getAsInt, getAsLong, getAsLong, getAsString, getAsString, getAt, getAt, getConverted, getConverted, getConverted, getConverted

Method Detail

set

void set(@Nonnull
         java.lang.String key,
         @Nonnull
         java.lang.Object value)

Sets a key/value pair on this configuration.

Parameters:

key - the key to be registered

value - the value to save

remove

@Nullable
java.lang.Object remove(@Nonnull
                                  java.lang.String key)

Removes a key from this configuration.

Parameters:

key - the key to be removed

Returns:

the value associated with the key or null if there wasn't any value.

removeAs

@Nullable
<T> T removeAs(@Nonnull
                         java.lang.String key)

Removes a key from this configuration. Blindly casts the returned value.

Parameters:

key - the key to be removed

Returns:

the value associated with the key or null if there wasn't any value.

Since:

2.5.0

removeConverted

@Nullable
<T> T removeConverted(@Nonnull
                                java.lang.String key,
                                @Nonnull
                                java.lang.Class<T> type)

Removes a key from this configuration. The value is converted to type T if found using a PropertyEditor.

Parameters:

key - the key to be removed

type - the type to be returned

Returns:

the value associated with the key or null if there wasn't any value.

Since:

2.5.0