HERE Android SDK Developer's Guide

CustomizableScheme

The class CustomizableScheme is a member of com.here.android.mpa.mapping.customization .

Class Summary

public class CustomizableScheme

extends java.lang.Object

Represent a scheme that can be customize.

[For complete information, see the section Class Details]

Nested Class Summary

Table 1. Nested Classes in CustomizableScheme
Nested Classes
`public static final enumeration CustomizableScheme.ErrorCode` Error code specific to configuration scheme or variable

Method Summary

Table 2. Methods in CustomizableScheme
Methods
`public boolean equals (Object obj)` For documentation, see java.lang.Object
`public String getName ()` Retrieve name of customizable scheme object.
`public int getVariableValue (SchemeColorProperty variable, double zoomLevel)` Retrieve color of an existing variable.
`public float getVariableValue (SchemeFloatProperty variable, double zoomLevel)` Retrieve value of an existing variable.
`public int getVariableValue (SchemeIntegerProperty variable, double zoomLevel)` Retrieve value to an existent integer variable.
`public int hashCode ()` For documentation, see java.lang.Object
`public boolean isValid ()` Returns true if the customizable scheme object is in a valid state, false otherwise.
`public ErrorCode setVariableValue (SchemeColorProperty variable, int value, ZoomRange range)` Sets color for an existing variable.
`public ErrorCode setVariableValue (SchemeFloatProperty variable, float value, ZoomRange range)` Sets value to an existing float variable.
`public ErrorCode setVariableValue (SchemeIntegerProperty variable, int value, ZoomRange range)` Sets value to existing integer variable.

Class Details

Represent a scheme that can be customize. A customizable scheme cannot be directly constructed, but one can be created through a Map object, by using an existing base Map.Scheme . Call Map#getCustomizableScheme(String) to get Customizable Scheme instance.

Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

obj

public String getName ()

Retrieve name of customizable scheme object.

Returns:

name of customizable scheme object OR null if this scheme is not valid.

public int getVariableValue (SchemeColorProperty variable, double zoomLevel)

Retrieve color of an existing variable.

Parameters:

variable
variable name
zoomLevel
Get value of variable for this zoom level.

Returns:

color value of variable for given zoom level.

Throws:

IllegalArgumentException
if variable is null OR zoomLevel is not valid

public float getVariableValue (SchemeFloatProperty variable, double zoomLevel)

Retrieve value of an existing variable.

Parameters:

variable
variable name
zoomLevel
Get value of variable for this zoom level.

Returns:

value of variable for given zoom level.

Throws:

IllegalArgumentException
if variable is null OR zoomLevel is not valid

public int getVariableValue (SchemeIntegerProperty variable, double zoomLevel)

Retrieve value to an existent integer variable.

Parameters:

variable
variable name
zoomLevel
Get value of variable for this zoom level.

Returns:

value of variable for given zoom level.

Throws:

IllegalArgumentException
if variable is null OR zoomLevel is not valid

public int hashCode ()

For documentation, see java.lang.Object

public boolean isValid ()

Returns true if the customizable scheme object is in a valid state, false otherwise.

A scheme may not be valid either because the scheme was removed or a new configuration has been set.

Returns:

true if the scheme is valid, false otherwise.

public ErrorCode setVariableValue (SchemeColorProperty variable, int value, ZoomRange range)

Sets color for an existing variable.

Parameters:

variable
Name of color variable. Can be get from CustomizableVariables class.
value
Value to set.
range
Zoom range where this variable value will come into effect.

Returns:

ERROR_NONE if operation was successful.
ERROR_INVALID_PARAMETERS if there's no variable with that name OR variable is null OR range is null or not valid
ERROR_INVALID_OPERATION if this scheme is not valid.
ERROR_OUT_OF_MEMORY if operation failed due to an out of memory error.

public ErrorCode setVariableValue (SchemeFloatProperty variable, float value, ZoomRange range)

Sets value to an existing float variable.

Parameters:

variable
Name of variable. Can be get from CustomizableVariables class.
value
Value to set.
range
Zoom range where this variable value will come into effect.

Returns:

ERROR_NONE if operation was successful.
ERROR_INVALID_PARAMETERS if there's no variable with that name OR variable is null OR range is null or not valid
ERROR_INVALID_OPERATION if this scheme is not valid.
ERROR_OUT_OF_MEMORY if operation failed due to an out of memory error.

public ErrorCode setVariableValue (SchemeIntegerProperty variable, int value, ZoomRange range)

Sets value to existing integer variable.

Parameters:

variable
Name of variable. Can be get from CustomizableVariables class.
value
Value to set.
range
Zoom range where this variable value will come into effect.

Returns:

ERROR_NONE if operation was successful.
ERROR_INVALID_PARAMETERS if there's no variable with that name OR variable is null OR range is null or not valid
ERROR_INVALID_OPERATION if this scheme is not valid.
ERROR_OUT_OF_MEMORY if operation failed due to an out of memory error.