com.actinarium.rhythm

Class SimpleArgumentsBundle

java.lang.Object

com.actinarium.rhythm.SimpleArgumentsBundle

All Implemented Interfaces:

ArgumentsBundle

Direct Known Subclasses:

MagicVariablesArgumentsBundle

public class SimpleArgumentsBundle
extends java.lang.Object
implements ArgumentsBundle

A basic implementation of ArgumentsBundle, which stores all arguments simply as a String->String key-value map and parses them into required types when accessed by respective getter methods (meaning it also fails lazily). Does not cache parsing results, so if the same arguments are requested multiple times, it may be a good idea to query them once and store the result in a variable.

Nested Class Summary

Nested classes/interfaces inherited from interface com.actinarium.rhythm.ArgumentsBundle

ArgumentsBundle.DimensionUnits, ArgumentsBundle.EdgeAffinity

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.regex.Pattern	DIMEN_VALUE_PATTERN
protected java.util.Map<java.lang.String,java.lang.String>	mArguments
protected android.util.DisplayMetrics	mMetrics

Fields inherited from interface com.actinarium.rhythm.ArgumentsBundle

UNITS_DP, UNITS_IN, UNITS_MM, UNITS_NULL, UNITS_NUMBER, UNITS_PERCENT, UNITS_PT, UNITS_PX, UNITS_SP

Constructor Summary

Constructors

Constructor and Description
SimpleArgumentsBundle(java.util.Map<java.lang.String,java.lang.String> arguments, android.util.DisplayMetrics metrics) Create a new simple arguments bundle implementation from provided key->value map.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
boolean	getBoolean(java.lang.String key, boolean defaultValue) Get boolean argument.
int	getColor(java.lang.String key, int defaultValue) Get argument value as color integer with fallback to default value if argument is missing.
float	getDimensionPixelExact(java.lang.String key, float defaultValue) Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid.
int	getDimensionPixelOffset(java.lang.String key, int defaultValue) Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid.
static float	getDimensionPixelRaw(float value, int units, android.util.DisplayMetrics metrics) Convert complex dimension value of provided units into pixels.
int	getDimensionPixelSize(java.lang.String key, int defaultValue) Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid.
int	getDimensionUnits(java.lang.String key) Get the units of a dimension argument.
float	getDimensionValue(java.lang.String key, float defaultValue) Get raw numeric value from dimension argument disregarding units and NOT performing any conversion to pixels.
android.util.DisplayMetrics	getDisplayMetrics() Get display metrics associated with this arguments bundle.
int	getEdgeAffinity(java.lang.String key, int defaultValue) Get argument as an ArgumentsBundle.EdgeAffinity constant, which can be either Gravity.TOP, Gravity.LEFT, Gravity.RIGHT, or Gravity.BOTTOM, with fallback to default value if argument is missing or invalid.
float	getFloat(java.lang.String key, float defaultValue) Get argument value as float with fallback to default value if argument is missing.
int	getGravity(java.lang.String key, int defaultValue) Get argument value as a gravity value (a combination of Gravity constants) with fallback to default value if argument is missing.
int	getInt(java.lang.String key, int defaultValue) Get argument value as integer with fallback to default value if argument is missing.
java.lang.String	getString(java.lang.String key) Get argument value as a string.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Get argument value as a string with fallback to default value if argument is missing.
boolean	hasArgument(java.lang.String key) Test if there's an argument with given key in the bundle, even if the value is null.
int	hashCode()
protected java.lang.String	resolveArgument(java.lang.String key) Resolves argument value from the bundle.

Methods inherited from class java.lang.Object

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

Field Detail

mArguments

protected java.util.Map<java.lang.String,java.lang.String> mArguments

mMetrics

protected android.util.DisplayMetrics mMetrics

DIMEN_VALUE_PATTERN

protected static java.util.regex.Pattern DIMEN_VALUE_PATTERN

Constructor Detail

SimpleArgumentsBundle

public SimpleArgumentsBundle(@NonNull
                             java.util.Map<java.lang.String,java.lang.String> arguments,
                             @NonNull
                             android.util.DisplayMetrics metrics)

Create a new simple arguments bundle implementation from provided key->value map.

Parameters:

arguments - A collection that maps arguments to values. In this implementation both the key and the value are raw strings, parsed into required data types as requested from the map. The values must be already provided as parsable literal values — this implementation cannot resolve variables or calculate expressions.
For performance reasons, this map will be used as is, therefore it must not be mutated. Furthermore this implementation lacks methods to put new parameters into the bag.

metrics - Display metrics associated with this arguments bundle, required so that dimension values (dp, sp etc) can be properly resolved.

Method Detail

getDisplayMetrics

public android.util.DisplayMetrics getDisplayMetrics()

Get display metrics associated with this arguments bundle.

Specified by:

getDisplayMetrics in interface ArgumentsBundle

Returns:

display metrics object

hasArgument

public boolean hasArgument(java.lang.String key)

Description copied from interface: ArgumentsBundle

Test if there's an argument with given key in the bundle, even if the value is null.

Specified by:

hasArgument in interface ArgumentsBundle

Parameters:

key - argument key

Returns:

true if argument is present regardless of value

resolveArgument

protected java.lang.String resolveArgument(java.lang.String key)

Resolves argument value from the bundle. This implementation simply returns the raw string as put in the argument map by the inflater. Used internally by all getXxx() methods — subclasses should override this method if additional processing is required (e.g. lazy variable dereference, expression evaluation etc).

Parameters:

key - key of the argument whose value to resolve

Returns:

string representation of the value

getString

public java.lang.String getString(java.lang.String key)

Get argument value as a string. For simple arguments bundle, will return the raw string as put in the arguments map by the inflater. If you need to change how raw value is resolved, override resolveArgument(String)

Specified by:

getString in interface ArgumentsBundle

Parameters:

key - argument key

Returns:

argument value as a string, or null if the argument has null value or it cannot be retrieved

getString

public java.lang.String getString(java.lang.String key,
                                  @Nullable
                                  java.lang.String defaultValue)

Get argument value as a string with fallback to default value if argument is missing. Will return the raw string as put in the arguments map by the inflater.

Specified by:

getString in interface ArgumentsBundle

Parameters:

key - argument key

defaultValue - fallback value

Returns:

argument value as raw string

getInt

public int getInt(java.lang.String key,
                  int defaultValue)

Description copied from interface: ArgumentsBundle

Get argument value as integer with fallback to default value if argument is missing.

Specified by:

getInt in interface ArgumentsBundle

Parameters:

key - argument key

defaultValue - fallback value

Returns:

argument value parsed as integer

getFloat

public float getFloat(java.lang.String key,
                      float defaultValue)

Description copied from interface: ArgumentsBundle

Get argument value as float with fallback to default value if argument is missing.

Specified by:

getFloat in interface ArgumentsBundle

Parameters:

key - argument key

defaultValue - fallback value

Returns:

argument value parsed as float

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)

Description copied from interface: ArgumentsBundle

Get boolean argument. Arguments specified as arg are identical to arg=true.

Specified by:

getBoolean in interface ArgumentsBundle

Parameters:

key - argument key

defaultValue - value if argument is not present

Returns:

argument boolean value

getColor

public int getColor(java.lang.String key,
                    int defaultValue)

Description copied from interface: ArgumentsBundle

Get argument value as color integer with fallback to default value if argument is missing.

Specified by:

getColor in interface ArgumentsBundle

Parameters:

key - argument key

defaultValue - fallback value

Returns:

argument value parsed as color integer

getGravity

public int getGravity(java.lang.String key,
                      int defaultValue)

Get argument value as a gravity value (a combination of Gravity constants) with fallback to default value if argument is missing. Does a quick and rough parsing of the raw string for containing constant words like top or center_vertical

Specified by:

getGravity in interface ArgumentsBundle

Parameters:

key - argument key

defaultValue - fallback value

Returns:

gravity constant

See Also:

ArgumentsBundle.getEdgeAffinity(String, int)

getEdgeAffinity

public int getEdgeAffinity(java.lang.String key,
                           int defaultValue)

Description copied from interface: ArgumentsBundle

Get argument as an ArgumentsBundle.EdgeAffinity constant, which can be either Gravity.TOP, Gravity.LEFT, Gravity.RIGHT, or Gravity.BOTTOM, with fallback to default value if argument is missing or invalid.

Specified by:

getEdgeAffinity in interface ArgumentsBundle

Parameters:

key - argument key

defaultValue - fallback value

Returns:

gravity constant

See Also:

ArgumentsBundle.getGravity(String, int)

getDimensionUnits

public int getDimensionUnits(java.lang.String key)

Get the units of a dimension argument. Note: this is a very crude implementation relying only on the check of trailing string characters (i.e. whether the string ends with "dp", "px", "%" etc). However, for development-time library and assuming that developers are not their own enemies, that should be fine.

Specified by:

getDimensionUnits in interface ArgumentsBundle

Parameters:

key - argument key

Returns:

dimension argument units, or ArgumentsBundle.UNITS_NULL if the argument is null or missing

getDimensionValue

public float getDimensionValue(java.lang.String key,
                               float defaultValue)

Get raw numeric value from dimension argument disregarding units and NOT performing any conversion to pixels.

Specified by:

getDimensionValue in interface ArgumentsBundle

Parameters:

key - argument key

defaultValue - fallback value in pixels

Returns:

dimension argument raw value

See Also:

getDimensionPixelRaw(float, int, DisplayMetrics)

getDimensionPixelExact

public float getDimensionPixelExact(java.lang.String key,
                                    float defaultValue)

Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid. Unlike ArgumentsBundle.getDimensionPixelSize(String, int) and ArgumentsBundle.getDimensionPixelSize(String, int), this method doesn't perform any rounding. Note: this method requires that DisplayMetrics object is injected in this config.

Specified by:

getDimensionPixelExact in interface ArgumentsBundle

Parameters:

key - argument key

defaultValue - fallback value in pixels

Returns:

argument value converted to pixels

See Also:

getDimensionPixelRaw(float, int, DisplayMetrics)

getDimensionPixelOffset

public int getDimensionPixelOffset(java.lang.String key,
                                   int defaultValue)

Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid. Unlike ArgumentsBundle.getDimensionPixelSize(String, int), this method is expected to round the raw value down to the closest integer. Note: this method requires that DisplayMetrics object is injected in this config.

Specified by:

getDimensionPixelOffset in interface ArgumentsBundle

Parameters:

key - argument key

defaultValue - fallback value in pixels

Returns:

argument value converted to pixels

See Also:

getDimensionPixelRaw(float, int, DisplayMetrics)

getDimensionPixelSize

public int getDimensionPixelSize(java.lang.String key,
                                 int defaultValue)

Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid. Unlike ArgumentsBundle.getDimensionPixelOffset(String, int)}, this method is expected to round the raw value up or down to the closest integer by common rules, and must ensure the result is at least 1px if original value is not 0. Note: this method requires that DisplayMetrics object is injected in this config.

Specified by:

getDimensionPixelSize in interface ArgumentsBundle

Parameters:

key - argument key

defaultValue - fallback value in pixels

Returns:

argument value converted to pixels

See Also:

getDimensionPixelRaw(float, int, DisplayMetrics)

getDimensionPixelRaw

public static float getDimensionPixelRaw(float value,
                                         int units,
                                         android.util.DisplayMetrics metrics)

Convert complex dimension value of provided units into pixels.

Parameters:

value - raw dimension value, e.g. 24f

units - dimension units, one of ArgumentsBundle.UNITS_PX, ArgumentsBundle.UNITS_DP, ArgumentsBundle.UNITS_SP, ArgumentsBundle.UNITS_PT, ArgumentsBundle.UNITS_IN, ArgumentsBundle.UNITS_MM, ArgumentsBundle.UNITS_NUMBER, ArgumentsBundle.UNITS_NULL, or ArgumentsBundle.UNITS_PERCENT

metrics - display metrics to convert complex dimension types that depend on density (dp, sp etc) into pixels, can be null if type is one of ArgumentsBundle.UNITS_PX, ArgumentsBundle.UNITS_PERCENT, ArgumentsBundle.UNITS_NUMBER, or ArgumentsBundle.UNITS_NULL

Returns:

dimension value in pixels

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object