org.mdi.bootstrap

Interface Configuration2

All Superinterfaces:

Configuration

All Known Implementing Classes:

AbstractConfiguration2

public interface Configuration2
extends Configuration

This interface extends the Configuration class to handle properties in a generic way. The only methods you have to implement are:

• getPropertiesTypes()
• setPropertyValue(java.lang.String, java.lang.Object)
• getPropertyValue(java.lang.String)

Usage example with one int property

 public class MyConfiguration implements Configuration2 {
   public static final String MY_INT_PROPERTY = "MyIntProperty";
   private static final SortedMap<String, Class<?>> properties = new TreeMap<>();
   static {
     properties.put(MY_INT_PROPERTY, Integer.Type);
   }
   private int intPropValue = 0;

   public SortedMap<String, Class<?>> getPropertiesTypes() {
     return properties;
   }

   public void setPropertyValue(String key, Object value) {
     if (key.equals(MY_INT_PROPERTY) && value instanceof Integer) {
       intPropValue = (Integer)value;
     }
   }
   public Object getPropertyValue(String key) {
     if (key.equals(MY_INT_PROPERTY)) {
       return intPropValue;
     } else {
       return null;
   }

 }
 

Since:

0.7.24

See Also:

Plugin.getPluginConfiguration()

Method Summary

Modifier and Type	Method and Description
default void	getConfiguration(java.util.prefs.Preferences pref, java.io.File dir) Called when the Preferences key-value entries must be updated with the configuration.
default java.lang.Object	getPrefValue(java.util.prefs.Preferences pref, java.lang.String key, java.lang.Object defValue, java.io.File dir) Return the Preferences value for a property.
java.util.SortedMap<java.lang.String,java.lang.Class<?>>	getPropertiesTypes() Return a sorted Map with the properties keys and their type.
java.lang.Object	getPropertyValue(java.lang.String key) Return the value for a property.
default boolean	getPropertyValueAsBoolean(java.lang.String key, boolean defaultValue) Return the value for a property as a boolean.
default char	getPropertyValueAsChar(java.lang.String key, char defaultValue) Return the value for a property as a char.
default java.io.File	getPropertyValueAsFile(java.lang.String key, java.io.File defaultValue) Return the value for a property as a File.
default float	getPropertyValueAsFloat(java.lang.String key, float defaultValue) Return the value for a property as a float.
default int	getPropertyValueAsInt(java.lang.String key, int defaultValue) Return the value for a property as an int.
default long	getPropertyValueAsLong(java.lang.String key, long defaultValue) Return the value for a property as a long.
default java.lang.String	getPropertyValueAsString(java.lang.String key, java.lang.String defaultValue) Return the value for a property as a String.
default java.net.URL	getPropertyValueAsURL(java.lang.String key, java.net.URL defaultValue) Return the value for a property as a URL.
default boolean	isShowingWarnings() Return true if warnings should be presented.
default void	putConfiguration(java.util.prefs.Preferences pref, java.io.File dir) Called when the configuration must be filled with key-value entries stored in a Preferences.
default void	putPrefValue(java.util.prefs.Preferences pref, java.lang.String key, java.lang.Object o, java.io.File dir) Put the Preferences value for a property.
void	setPropertyValue(java.lang.String key, java.lang.Object value) Set the value for a property.
default void	warning(java.lang.String message) Emit a warning.

Methods inherited from interface org.mdi.bootstrap.Configuration

setupApplicationDesc

Method Detail

getPropertiesTypes

java.util.SortedMap<java.lang.String,java.lang.Class<?>> getPropertiesTypes()

Return a sorted Map with the properties keys and their type.

Handling properties types

The properties types which are handled by default are:

• char properties: Character or Character.TYPE
• int properties: Integer or Integer.TYPE
• float properties: Float or Float.TYPE
• long properties: Long or Long.TYPE
• boolean properties: Boolean
• String properties: String
• File and URL properties: File and URL

Returns:

the properties types class

setPropertyValue

void setPropertyValue(java.lang.String key,
                      java.lang.Object value)

Set the value for a property.

Parameters:

key - the property key

value - the property value

getPropertyValue

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

Return the value for a property.

Parameters:

key - the property key

Returns:

the property value

isShowingWarnings

default boolean isShowingWarnings()

Return true if warnings should be presented.

Returns:

true by default

warning

default void warning(java.lang.String message)

Emit a warning. The default implementation will print on the err streamif isShowingWarnings() returns true.

Parameters:

message - the message

getPropertyValueAsChar

default char getPropertyValueAsChar(java.lang.String key,
                                    char defaultValue)

Return the value for a property as a char.

Parameters:

key - the property key

defaultValue - the default value

Returns:

the property value

getPropertyValueAsInt

default int getPropertyValueAsInt(java.lang.String key,
                                  int defaultValue)

Return the value for a property as an int.

Parameters:

key - the property key

defaultValue - the default value

Returns:

the property value

getPropertyValueAsFloat

default float getPropertyValueAsFloat(java.lang.String key,
                                      float defaultValue)

Return the value for a property as a float.

Parameters:

key - the property key

defaultValue - the default value

Returns:

the property value

getPropertyValueAsLong

default long getPropertyValueAsLong(java.lang.String key,
                                    long defaultValue)

Return the value for a property as a long.

Parameters:

key - the property key

defaultValue - the default value

Returns:

the property value

getPropertyValueAsBoolean

default boolean getPropertyValueAsBoolean(java.lang.String key,
                                          boolean defaultValue)

Return the value for a property as a boolean.

Parameters:

key - the property key

defaultValue - the default value

Returns:

the property value

getPropertyValueAsFile

default java.io.File getPropertyValueAsFile(java.lang.String key,
                                            java.io.File defaultValue)

Return the value for a property as a File.

Parameters:

key - the property key

defaultValue - the default value

Returns:

the property value

getPropertyValueAsURL

default java.net.URL getPropertyValueAsURL(java.lang.String key,
                                           java.net.URL defaultValue)

Return the value for a property as a URL.

Parameters:

key - the property key

defaultValue - the default value

Returns:

the property value

getPropertyValueAsString

default java.lang.String getPropertyValueAsString(java.lang.String key,
                                                  java.lang.String defaultValue)

Return the value for a property as a String.

Parameters:

key - the property key

defaultValue - the default value

Returns:

the property value

putPrefValue

default void putPrefValue(java.util.prefs.Preferences pref,
                          java.lang.String key,
                          java.lang.Object o,
                          java.io.File dir)

Put the Preferences value for a property. This can be used if the property type is not handled by default.

Parameters:

pref - the Preferences

key - the property key

o - the property value

dir - the directory to use as a current directory to store File preferences. This parameter can be used for the configuration to define the File preference path relative to the directory, but a Configuration might also not take this parameter into account at all

getPrefValue

default java.lang.Object getPrefValue(java.util.prefs.Preferences pref,
                                      java.lang.String key,
                                      java.lang.Object defValue,
                                      java.io.File dir)

Return the Preferences value for a property. This can be used if the property type is not handled by default.

Parameters:

pref - the Preferences

key - the property key

defValue - the property default value

dir - the directory to use as a current directory to store File preferences. This parameter can be used for the configuration to define the File preference path relative to the directory, but a Configuration might also not take this parameter into account at all

Returns:

the Preferences value for the property

putConfiguration

default void putConfiguration(java.util.prefs.Preferences pref,
                              java.io.File dir)

Called when the configuration must be filled with key-value entries stored in a Preferences.

Handling properties types

The properties types which are handled by default are:

• int properties: Integer or Integer.TYPE
• float properties: Float or Float.TYPE
• long properties: Long or Long.TYPE
• boolean properties: Boolean
• String properties: String
• File and URL properties: File and URL

If a property native type is not handled, the putPrefValue(java.util.prefs.Preferences, java.lang.String, java.lang.Object, java.io.File) will be used.

Specified by:

putConfiguration in interface Configuration

Parameters:

pref - the Preferences

dir - the directory to use as a current directory to store File preferences. This parameter can be used for the configuration to define the File preference path relative to the directory, but a Configuration might also not take this parameter into account at all

getConfiguration

default void getConfiguration(java.util.prefs.Preferences pref,
                              java.io.File dir)

Called when the Preferences key-value entries must be updated with the configuration.

Handling properties types

The properties types which are handled by default are:

• char properties: Character or Character.TYPE
• int properties: Integer or Integer.TYPE
• float properties: Float or Float.TYPE
• long properties: Long or Long.TYPE
• boolean properties: Boolean
• String properties: String
• File and URL properties: File and URL

If a property native type is not handled, the getPrefValue(java.util.prefs.Preferences, java.lang.String, java.lang.Object, java.io.File) will be used.

Specified by:

getConfiguration in interface Configuration

Parameters:

pref - the Preferences

dir - the directory to use as a current directory to store File preferences. This parameter can be used for the configuration to define the File preference path relative to the directory, but a Configuration might also not take this parameter into account at all