com.neovisionaries.android.util

Class TypedProperties

java.lang.Object

com.neovisionaries.android.util.TypedProperties

Direct Known Subclasses:

Preferences, StringBasedTypedProperties

public abstract class TypedProperties
extends Object

This is an abstract class that provides getters and setters for key-value pairs. Subclasses are required to implement the following abstract methods.

• void clear()
• boolean contains(String key)
• boolean getBoolean(String key, boolean defaultValue)
• float getFloat(String key, float defaultValue)
• double getDouble(String key, double defaultValue)
• int getInt(String key, int defaultValue)
• long getLong(String key, long defaultValue)
• String getString(String key, String defaultValue)
• void remove(String key)
• void setBoolean(String key, boolean value)
• void setFloat(String key, float value)
• void setDouble(String key, double value)
• void setInt(String key, int value)
• void setLong(String key, long value)
• void setString(String key, String value)

All non-abstract methods in this class are just wrappers over the abstract methods listed above.

Author:

Takahiko Kawasaki

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TypedProperties()

Method Summary

Modifier and Type	Method and Description
abstract void	clear() Clear all properties.
boolean	contains(Enum<?> key) Equivalent to contains(key.name()).
abstract boolean	contains(String key) Check if the property identified by the key exists.
String	get(Enum<?> key) Equivalent to getString(key).
boolean	get(Enum<?> key, boolean defaultValue) Equivalent to getBoolean(key, defaultValue).
<TEnum extends Enum<TEnum>> TEnum	get(Enum<?> key, Class<TEnum> enumClass, TEnum defaultValue) Equivalent to getEnum(key, enumClass, defaultValue).
double	get(Enum<?> key, double defaultValue) Equivalent to getFloat(key, defaultValue).
float	get(Enum<?> key, float defaultValue) Equivalent to getFloat(key, defaultValue).
int	get(Enum<?> key, int defaultValue) Equivalent to getInt(key, defaultValue).
long	get(Enum<?> key, long defaultValue) Equivalent to getLong(key, defaultValue).
String	get(Enum<?> key, String defaultValue) Equivalent to getString(key, defaultValue).
<TEnum extends Enum<TEnum>> TEnum	get(Enum<?> key, TEnum defaultValue) Equivalent to getEnum(key, (Class<TEnum>)defaultValue.getClass(), defaultValue).
String	get(String key) Equivalent to getString(key).
boolean	get(String key, boolean defaultValue) Equivalent to getBoolean(key, defaultValue).
<TEnum extends Enum<TEnum>> TEnum	get(String key, Class<TEnum> enumClass, TEnum defaultValue) Equivalent to getEnum(key, enumClass, defaultValue).
double	get(String key, double defaultValue) Equivalent to getDouble(key, defaultValue).
float	get(String key, float defaultValue) Equivalent to getFloat(key, defaultValue).
int	get(String key, int defaultValue) Equivalent to getInt(key, defaultValue).
long	get(String key, long defaultValue) Equivalent to getLong(key, defaultValue).
String	get(String key, String defaultValue) Equivalent to getString(key, defaultValue).
<TEnum extends Enum<TEnum>> TEnum	get(String key, TEnum defaultValue) Equivalent to getEnum(key, (Class<TEnum>)defaultValue.getClass(), defaultValue).
boolean	getBoolean(Enum<?> key) Equivalent to getBoolean(key.name()).
boolean	getBoolean(Enum<?> key, boolean defaultValue) Equivalent to getBoolean(key.name(), defaultValue).
boolean	getBoolean(String key) Equivalent to getBoolean(key, false).
abstract boolean	getBoolean(String key, boolean defaultValue) Get the value of the property identified by the key as boolean.
double	getDouble(Enum<?> key) Equivalent to getDouble(key.name()).
double	getDouble(Enum<?> key, double defaultValue) Equivalent to getDouble(key.name(), defaultValue).
double	getDouble(String key) Equivalent to getDouble(key, 0.0F).
abstract double	getDouble(String key, double defaultValue) Get the value of the property identified by the key as double.
<TEnum extends Enum<TEnum>> TEnum	getEnum(Enum<?> key, Class<TEnum> enumClass) Equivalent to getEnum(key.name(), enumClass).
<TEnum extends Enum<TEnum>> TEnum	getEnum(Enum<?> key, Class<TEnum> enumClass, TEnum defaultValue) Equivalent to getEnum(key.name(), enumClass, defaultValue).
<TEnum extends Enum<TEnum>> TEnum	getEnum(Enum<?> key, TEnum defaultValue) Equivalent to getEnum(key, (Class<TEnum>)defaultValue.getClass(), defaultValue).
<TEnum extends Enum<TEnum>> TEnum	getEnum(String key, Class<TEnum> enumClass) Equivalent to getEnum(key, enumClass, null).
<TEnum extends Enum<TEnum>> TEnum	getEnum(String key, Class<TEnum> enumClass, TEnum defaultValue) Get the value of the property identified by the key as Enum.
<TEnum extends Enum<TEnum>> TEnum	getEnum(String key, TEnum defaultValue) Equivalent to getEnum(key, (Class<TEnum>)defaultValue.getClass(), defaultValue).
float	getFloat(Enum<?> key) Equivalent to getFloat(key.name()).
float	getFloat(Enum<?> key, float defaultValue) Equivalent to getFloat(key.name(), defaultValue).
float	getFloat(String key) Equivalent to getFloat(key, 0.0F).
abstract float	getFloat(String key, float defaultValue) Get the value of the property identified by the key as float.
int	getInt(Enum<?> key) Equivalent to getInt(key.name()).
int	getInt(Enum<?> key, int defaultValue) Equivalent to getInt(key.name(), defaultValue).
int	getInt(String key) Equivalent to getInt(key, 0).
abstract int	getInt(String key, int defaultValue) Get the value of the property identified by the key as int.
long	getLong(Enum<?> key) Equivalent to getLong(key.name()).
long	getLong(Enum<?> key, long defaultValue) Equivalent to getLong(key.name(), defaultValue).
long	getLong(String key) Equivalent to getLong(key, 0L).
abstract long	getLong(String key, long defaultValue) Get the value of the property identified by the key as long.
String	getString(Enum<?> key) Equivalent to getString(key.name()).
String	getString(Enum<?> key, String defaultValue) Equivalent to getString(key.name(), defaultValue).
String	getString(String key) Equivalent to getString(key, null).
abstract String	getString(String key, String defaultValue) Get the value of the property identified by the key as String.
void	remove(Enum<?> key) Equivalent to remove(key.name()).
abstract void	remove(String key) Remove the property identified by the key.
void	set(Enum<?> key, boolean value) Equivalent to setBoolean(key, value).
void	set(Enum<?> key, double value) Equivalent to setDouble(key, value).
void	set(Enum<?> key, float value) Equivalent to setFloat(key, value).
void	set(Enum<?> key, int value) Equivalent to setInt(key, value).
void	set(Enum<?> key, long value) Equivalent to setLong(key, value).
void	set(Enum<?> key, String value) Equivalent to setString(key, value).
<TEnum extends Enum<TEnum>> void	set(Enum<?> key, TEnum value) Equivalent to setEnum(key, value).
void	set(String key, boolean value) Equivalent to setBoolean(key, value).
void	set(String key, double value) Equivalent to setDouble(key, value).
void	set(String key, float value) Equivalent to setFloat(key, value).
void	set(String key, int value) Equivalent to setInt(key, value).
void	set(String key, long value) Equivalent to setLong(key, value).
void	set(String key, String value) Equivalent to setString(key, value).
<TEnum extends Enum<TEnum>> void	set(String key, TEnum value) Equivalent to setEnum(key, value).
void	setBoolean(Enum<?> key, boolean value) Equivalent to setBoolean(key.name(), value).
abstract void	setBoolean(String key, boolean value) Set the value to the property identified by the key.
void	setDouble(Enum<?> key, double value) Equivalent to setDouble(key.name(), value).
abstract void	setDouble(String key, double value) Set the value to the property identified by the key.
<TEnum extends Enum<TEnum>> void	setEnum(Enum<?> key, TEnum value) Equivalent to setEnum(key.name(), value).
<TEnum extends Enum<TEnum>> void	setEnum(String key, TEnum value) Equivalent to setString(key, (value == null) ? null : value.name()).
void	setFloat(Enum<?> key, float value) Equivalent to setFloat(key.name(), value).
abstract void	setFloat(String key, float value) Set the value to the property identified by the key.
void	setInt(Enum<?> key, int value) Equivalent to setInt(key.name(), value).
abstract void	setInt(String key, int value) Set the value to the property identified by the key.
void	setLong(Enum<?> key, long value) Equivalent to setLong(key.name(), value).
abstract void	setLong(String key, long value) Set the value to the property identified by the key.
void	setString(Enum<?> key, String value) Equivalent to setString(key.name(), value).
abstract void	setString(String key, String value) Set the value to the property identified by the key.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedProperties

protected TypedProperties()

Method Detail

contains

public abstract boolean contains(String key)

Check if the property identified by the key exists.

Since:

1.6

contains

public boolean contains(Enum<?> key)

Equivalent to contains(key.name()).

Since:

1.6

getBoolean

public abstract boolean getBoolean(String key,
                                   boolean defaultValue)

Get the value of the property identified by the key as boolean. If key is null or there is no property for the key, defaultValue is returned.

get

public boolean get(String key,
                   boolean defaultValue)

Equivalent to getBoolean(key, defaultValue).

getBoolean

public boolean getBoolean(String key)

Equivalent to getBoolean(key, false).

getBoolean

public boolean getBoolean(Enum<?> key,
                          boolean defaultValue)

Equivalent to getBoolean(key.name(), defaultValue). If key is null, defaultValue is returned.

get

public boolean get(Enum<?> key,
                   boolean defaultValue)

Equivalent to getBoolean(key, defaultValue).

getBoolean

public boolean getBoolean(Enum<?> key)

Equivalent to getBoolean(key.name()). if key is null, false is returned.

getFloat

public abstract float getFloat(String key,
                               float defaultValue)

Get the value of the property identified by the key as float. If key is null or there is no property for the key, defaultValue is returned.

get

public float get(String key,
                 float defaultValue)

Equivalent to getFloat(key, defaultValue).

getFloat

public float getFloat(String key)

Equivalent to getFloat(key, 0.0F).

getFloat

public float getFloat(Enum<?> key,
                      float defaultValue)

Equivalent to getFloat(key.name(), defaultValue). If key is null, defaultValue is returned.

get

public float get(Enum<?> key,
                 float defaultValue)

Equivalent to getFloat(key, defaultValue).

getFloat

public float getFloat(Enum<?> key)

Equivalent to getFloat(key.name()). If key is null, 0.0F is returned.

getDouble

public abstract double getDouble(String key,
                                 double defaultValue)

Get the value of the property identified by the key as double. If key is null or there is no property for the key, defaultValue is returned.

Since:

1.12

get

public double get(String key,
                  double defaultValue)

Equivalent to getDouble(key, defaultValue).

Since:

1.12

getDouble

public double getDouble(String key)

Equivalent to getDouble(key, 0.0F).

Since:

1.12

getDouble

public double getDouble(Enum<?> key,
                        double defaultValue)

Equivalent to getDouble(key.name(), defaultValue). If key is null, defaultValue is returned.

Since:

1.12

get

public double get(Enum<?> key,
                  double defaultValue)

Equivalent to getFloat(key, defaultValue).

Since:

1.12

getDouble

public double getDouble(Enum<?> key)

Equivalent to getDouble(key.name()). If key is null, 0.0 is returned.

Since:

1.12

getInt

public abstract int getInt(String key,
                           int defaultValue)

Get the value of the property identified by the key as int. If key is null or there is no property for the key, defaultValue is returned.

get

public int get(String key,
               int defaultValue)

Equivalent to getInt(key, defaultValue).

getInt

public int getInt(String key)

Equivalent to getInt(key, 0).

getInt

public int getInt(Enum<?> key,
                  int defaultValue)

Equivalent to getInt(key.name(), defaultValue). If key is null}, defaultValue is returned.

get

public int get(Enum<?> key,
               int defaultValue)

Equivalent to getInt(key, defaultValue).

getInt

public int getInt(Enum<?> key)

Equivalent to getInt(key.name()). If key is null, 0 is returned.

getLong

public abstract long getLong(String key,
                             long defaultValue)

Get the value of the property identified by the key as long. If key is null or there is no property for the key, defaultValue is returned.

get

public long get(String key,
                long defaultValue)

Equivalent to getLong(key, defaultValue).

getLong

public long getLong(String key)

Equivalent to getLong(key, 0L).

getLong

public long getLong(Enum<?> key,
                    long defaultValue)

Equivalent to getLong(key.name(), defaultValue). If key is null, defaultValue is returned.

get

public long get(Enum<?> key,
                long defaultValue)

Equivalent to getLong(key, defaultValue).

getLong

public long getLong(Enum<?> key)

Equivalent to getLong(key.name()). If key is null, 0L is returned.

getEnum

public <TEnum extends Enum<TEnum>> TEnum getEnum(String key,
                                                 Class<TEnum> enumClass,
                                                 TEnum defaultValue)

Get the value of the property identified by the key as Enum. If key is null or there is no property for the key, defaultValue is returned.

Since:

1.6

getEnum

public <TEnum extends Enum<TEnum>> TEnum getEnum(String key,
                                                 TEnum defaultValue)

Equivalent to getEnum(key, (Class<TEnum>)defaultValue.getClass(), defaultValue). defaultValue must not be null.

Since:

1.6

get

public <TEnum extends Enum<TEnum>> TEnum get(String key,
                                             Class<TEnum> enumClass,
                                             TEnum defaultValue)

Equivalent to getEnum(key, enumClass, defaultValue).

Since:

1.6

get

public <TEnum extends Enum<TEnum>> TEnum get(String key,
                                             TEnum defaultValue)

Equivalent to getEnum(key, (Class<TEnum>)defaultValue.getClass(), defaultValue). defaultValue must not be null.

Since:

1.6

getEnum

public <TEnum extends Enum<TEnum>> TEnum getEnum(String key,
                                                 Class<TEnum> enumClass)

Equivalent to getEnum(key, enumClass, null).

Since:

1.6

getEnum

public <TEnum extends Enum<TEnum>> TEnum getEnum(Enum<?> key,
                                                 Class<TEnum> enumClass,
                                                 TEnum defaultValue)

Equivalent to getEnum(key.name(), enumClass, defaultValue). If key is null, defaultValue is returned.

Since:

1.6

getEnum

public <TEnum extends Enum<TEnum>> TEnum getEnum(Enum<?> key,
                                                 TEnum defaultValue)

Equivalent to getEnum(key, (Class<TEnum>)defaultValue.getClass(), defaultValue). defaultValue must not be null.

Since:

1.6

get

public <TEnum extends Enum<TEnum>> TEnum get(Enum<?> key,
                                             Class<TEnum> enumClass,
                                             TEnum defaultValue)

Equivalent to getEnum(key, enumClass, defaultValue).

Since:

1.6

get

public <TEnum extends Enum<TEnum>> TEnum get(Enum<?> key,
                                             TEnum defaultValue)

Equivalent to getEnum(key, (Class<TEnum>)defaultValue.getClass(), defaultValue). defaultValue must not be null.

Since:

1.6

getEnum

public <TEnum extends Enum<TEnum>> TEnum getEnum(Enum<?> key,
                                                 Class<TEnum> enumClass)

Equivalent to getEnum(key.name(), enumClass). If key is null, null is returned.

Since:

1.6

getString

public abstract String getString(String key,
                                 String defaultValue)

Get the value of the property identified by the key as String. If key is null or there is no property for the key, defaultValue is returned.

get

public String get(String key,
                  String defaultValue)

Equivalent to getString(key, defaultValue).

getString

public String getString(String key)

Equivalent to getString(key, null).

get

public String get(String key)

Equivalent to getString(key).

getString

public String getString(Enum<?> key,
                        String defaultValue)

Equivalent to getString(key.name(), defaultValue). If key is null, defaultValue is returned.

get

public String get(Enum<?> key,
                  String defaultValue)

Equivalent to getString(key, defaultValue).

getString

public String getString(Enum<?> key)

Equivalent to getString(key.name()). If key is null, null is returned.

get

public String get(Enum<?> key)

Equivalent to getString(key).

setBoolean

public abstract void setBoolean(String key,
                                boolean value)

Set the value to the property identified by the key. If key is null, nothing is done.

set

public void set(String key,
                boolean value)

Equivalent to setBoolean(key, value).

setBoolean

public void setBoolean(Enum<?> key,
                       boolean value)

Equivalent to setBoolean(key.name(), value). If key is null, nothing is done.

set

public void set(Enum<?> key,
                boolean value)

Equivalent to setBoolean(key, value).

setFloat

public abstract void setFloat(String key,
                              float value)

Set the value to the property identified by the key. If key is null, nothing is done.

set

public void set(String key,
                float value)

Equivalent to setFloat(key, value).

setFloat

public void setFloat(Enum<?> key,
                     float value)

Equivalent to setFloat(key.name(), value). If key is null, nothing is done.

set

public void set(Enum<?> key,
                float value)

Equivalent to setFloat(key, value).

setDouble

public abstract void setDouble(String key,
                               double value)

Set the value to the property identified by the key. If key is null, nothing is done.

Since:

1.12

set

public void set(String key,
                double value)

Equivalent to setDouble(key, value).

Since:

1.12

setDouble

public void setDouble(Enum<?> key,
                      double value)

Equivalent to setDouble(key.name(), value). If key is null, nothing is done.

Since:

1.12

set

public void set(Enum<?> key,
                double value)

Equivalent to setDouble(key, value).

Since:

1.12

setInt

public abstract void setInt(String key,
                            int value)

Set the value to the property identified by the key. If key is null, nothing is done.

set

public void set(String key,
                int value)

Equivalent to setInt(key, value).

setInt

public void setInt(Enum<?> key,
                   int value)

Equivalent to setInt(key.name(), value). If key is null, nothing is done.

set

public void set(Enum<?> key,
                int value)

Equivalent to setInt(key, value).

setLong

public abstract void setLong(String key,
                             long value)

Set the value to the property identified by the key. If key is null, nothing is done.

set

public void set(String key,
                long value)

Equivalent to setLong(key, value).

setLong

public void setLong(Enum<?> key,
                    long value)

Equivalent to setLong(key.name(), value). If key is null, nothing is done.

set

public void set(Enum<?> key,
                long value)

Equivalent to setLong(key, value).

setEnum

public <TEnum extends Enum<TEnum>> void setEnum(String key,
                                                TEnum value)

Equivalent to setString(key, (value == null) ? null : value.name()).

Since:

1.6

set

public <TEnum extends Enum<TEnum>> void set(String key,
                                            TEnum value)

Equivalent to setEnum(key, value).

Since:

1.6

setEnum

public <TEnum extends Enum<TEnum>> void setEnum(Enum<?> key,
                                                TEnum value)

Equivalent to setEnum(key.name(), value). If key is null, nothing is done.

Since:

1.6

set

public <TEnum extends Enum<TEnum>> void set(Enum<?> key,
                                            TEnum value)

Equivalent to setEnum(key, value).

Since:

1.6

setString

public abstract void setString(String key,
                               String value)

Set the value to the property identified by the key. If key is null, nothing is done.

set

public void set(String key,
                String value)

Equivalent to setString(key, value).

setString

public void setString(Enum<?> key,
                      String value)

Equivalent to setString(key.name(), value). If key is null, nothing is done.

set

public void set(Enum<?> key,
                String value)

Equivalent to setString(key, value).

remove

public abstract void remove(String key)

Remove the property identified by the key. If key is null, nothing is done.

remove

public void remove(Enum<?> key)

Equivalent to remove(key.name()). If key is null, nothing is done.

clear

public abstract void clear()

Clear all properties.