com.actinarium.rhythm

Class MagicVariablesArgumentsBundle

java.lang.Object

com.actinarium.rhythm.SimpleArgumentsBundle

com.actinarium.rhythm.MagicVariablesArgumentsBundle

All Implemented Interfaces:

ArgumentsBundle

public class MagicVariablesArgumentsBundle
extends SimpleArgumentsBundle

An implementation of ArgumentsBundle that utilizes “magic variables” mechanism to resolve missing layer arguments: if an argument is not explicitly specified, it tries resolving it from a variable named in a special pattern @{layer_name}_{arg_name} where dashes are replaced with underscores.

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 java.lang.String	mLayerNamePrefix
protected java.util.Map<java.lang.String,java.lang.String>	mVariables

Fields inherited from class com.actinarium.rhythm.SimpleArgumentsBundle

DIMEN_VALUE_PATTERN, mArguments, 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
MagicVariablesArgumentsBundle(java.util.Map<java.lang.String,java.lang.String> arguments, java.util.Map<java.lang.String,java.lang.String> variables, java.lang.String layerName, 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	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 com.actinarium.rhythm.SimpleArgumentsBundle

getBoolean, getColor, getDimensionPixelExact, getDimensionPixelOffset, getDimensionPixelRaw, getDimensionPixelSize, getDimensionUnits, getDimensionValue, getDisplayMetrics, getEdgeAffinity, getFloat, getGravity, getInt, getString, getString

Methods inherited from class java.lang.Object

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

Field Detail

mLayerNamePrefix

protected java.lang.String mLayerNamePrefix

mVariables

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

Constructor Detail

MagicVariablesArgumentsBundle

public MagicVariablesArgumentsBundle(@NonNull
                                     java.util.Map<java.lang.String,java.lang.String> arguments,
                                     @NonNull
                                     java.util.Map<java.lang.String,java.lang.String> variables,
                                     java.lang.String layerName,
                                     @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.

variables - A @key->value map containing magic variables to fall back to

layerName - Layer name as registered in the factory, e.g. grid-lines

metrics - Display metrics associated with this arguments bundle, required so that dimension values (dp, sp

Method Detail

hasArgument

public boolean hasArgument(java.lang.String key)

Test if there's an argument with given key in the bundle, even if the value is null. If the argument is not declared explicitly, will look up if a matching magic variable is present.

Specified by:

hasArgument in interface ArgumentsBundle

Overrides:

hasArgument in class SimpleArgumentsBundle

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. If the argument is not present in this bundle's arguments map, tries to fall back to a variable with a magic name of @{layer_name}_{arg_name} (concatenated layer and argument names with dashes replaced by underscores).

Overrides:

resolveArgument in class SimpleArgumentsBundle

Parameters:

key - key of the argument whose value to resolve

Returns:

string representation of resolved value

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class SimpleArgumentsBundle

hashCode

public int hashCode()

Overrides:

hashCode in class SimpleArgumentsBundle