public interface

HtcCustomization

com.htc.customization.HtcCustomization
Known Indirect Subclasses

Class Overview

Provide methods to retrieve the customization settings.

Summary

Public Methods
abstract List<Boolean> getBoolList(String key)
Get the Boolean values related to the key.
abstract boolean getBoolValue(String key)
Get one boolean primitive value related to the key.
abstract boolean getBoolValue(String key, boolean defaultValue)
Get one boolean primitive value related to the key.
abstract List<Integer> getIntList(String key)
Get the Integer values related to the key.
abstract int getIntValue(String key, int defaultValue)
Get one int primitive value related to the key.
abstract int getIntValue(String key)
Get one int primitive value related to the key.
abstract List<String> getStringList(String key)
Get the String values related to the key.
abstract String getStringValue(String key, String defaultValue)
Get one String value related to the key.
abstract String getStringValue(String key)
Get one String value related to the key.

Public Methods

public abstract List<Boolean> getBoolList (String key)

Get the Boolean values related to the key.

Parameters
key the predefined formatted string used to retrieve the related values. The format of the string may look like A.B.C.D...
Returns
  • a List containing the Boolean values related to the key.
Throws
CustomizationValueNotFoundException if there is no value corresponding to the key

public abstract boolean getBoolValue (String key)

Get one boolean primitive value related to the key.

Parameters
key the predefined formatted string used to retrieve the related values. The format of the string may look like A.B.C.D...
Returns
  • the value related to the key
Throws
CustomizationValueNotFoundException if there is no value corresponding to the key

public abstract boolean getBoolValue (String key, boolean defaultValue)

Get one boolean primitive value related to the key.

Parameters
key the predefined formatted string used to retrieve the related values. The format of the string may look like A.B.C.D...
defaultValue used to be the return value if there is no value related to the key.
Returns
  • the value related to the key, if it exists. Otherwise, return the defaultValue.

public abstract List<Integer> getIntList (String key)

Get the Integer values related to the key.

Parameters
key the predefined formatted string used to retrieve the related values. The format of the string may look like A.B.C.D...
Returns
  • a List containing the Integer values related to the key.
Throws
CustomizationValueNotFoundException if there is no value corresponding to the key
NumberFormatException if the value(s) cannot be casted to Integer type

public abstract int getIntValue (String key, int defaultValue)

Get one int primitive value related to the key.

Parameters
key the predefined formatted string used to retrieve the related values. The format of the string may look like A.B.C.D...
defaultValue used to be the return value if there is no value related to the key.
Returns
  • the value related to the key, if it exists. Otherwise, return the defaultValue.

public abstract int getIntValue (String key)

Get one int primitive value related to the key.

Parameters
key the predefined formatted string used to retrieve the related values. The format of the string may look like A.B.C.D...
Returns
  • the value related to the key
Throws
CustomizationValueNotFoundException if there is no value corresponding to the key
NumberFormatException if the value(s) cannot be casted to Integer type

public abstract List<String> getStringList (String key)

Get the String values related to the key.

Parameters
key the predefined formatted string used to retrieve the related values. The format of the string may look like A.B.C.D...
Returns
  • a List containing the String values related to the key.
Throws
CustomizationValueNotFoundException if there is no value corresponding to the key

public abstract String getStringValue (String key, String defaultValue)

Get one String value related to the key.

Parameters
key the predefined formatted string used to retrieve the related values. The format of the string may look like A.B.C.D...
defaultValue used to be the return value if there is no value related to the key.
Returns
  • the value related to the key, if it exists. Otherwise, return the defaultValue.

public abstract String getStringValue (String key)

Get one String value related to the key.

Parameters
key the predefined formatted string used to retrieve the related values. The format of the string may look like A.B.C.D...
Returns
  • the value related to the key
Throws
CustomizationValueNotFoundException if there is no value corresponding to the key