com.ctrip.framework.apollo

Interface Config

All Known Implementing Classes:

AbstractConfig, DefaultConfig, SimpleConfig

public interface Config

Author:

Jason Song(song_s@ctrip.com)

Method Summary

Methods

Modifier and Type	Method and Description
void	addChangeListener(ConfigChangeListener listener) Add change listener to this config instance, will be notified when any key is changed in this namespace.
void	addChangeListener(ConfigChangeListener listener, Set<String> interestedKeys) Add change listener to this config instance, will only be notified when any of the interested keys is changed in this namespace.
void	addChangeListener(ConfigChangeListener listener, Set<String> interestedKeys, Set<String> interestedKeyPrefixes) Add change listener to this config instance, will only be notified when any of the interested keys is changed in this namespace.
String[]	getArrayProperty(String key, String delimiter, String[] defaultValue) Return the array property value with the given key, or defaultValue if the key doesn't exist.
Boolean	getBooleanProperty(String key, Boolean defaultValue) Return the boolean property value with the given key, or defaultValue if the key doesn't exist.
Byte	getByteProperty(String key, Byte defaultValue) Return the byte property value with the given key, or defaultValue if the key doesn't exist.
Date	getDateProperty(String key, Date defaultValue) Return the Date property value with the given name, or defaultValue if the name doesn't exist.
Date	getDateProperty(String key, String format, Date defaultValue) Return the Date property value with the given name, or defaultValue if the name doesn't exist.
Date	getDateProperty(String key, String format, Locale locale, Date defaultValue) Return the Date property value with the given name, or defaultValue if the name doesn't exist.
Double	getDoubleProperty(String key, Double defaultValue) Return the double property value with the given key, or defaultValue if the key doesn't exist.
long	getDurationProperty(String key, long defaultValue) Return the duration property value(in milliseconds) with the given name, or defaultValue if the name doesn't exist.
<T extends Enum<T>> T	getEnumProperty(String key, Class<T> enumType, T defaultValue) Return the Enum property value with the given key, or defaultValue if the key doesn't exist.
Float	getFloatProperty(String key, Float defaultValue) Return the float property value with the given key, or defaultValue if the key doesn't exist.
Integer	getIntProperty(String key, Integer defaultValue) Return the integer property value with the given key, or defaultValue if the key doesn't exist.
Long	getLongProperty(String key, Long defaultValue) Return the long property value with the given key, or defaultValue if the key doesn't exist.
<T> T	getProperty(String key, com.google.common.base.Function<String,T> function, T defaultValue) Return the user-defined property value with the given key, or defaultValue if the key doesn't exist.
String	getProperty(String key, String defaultValue) Return the property value with the given key, or defaultValue if the key doesn't exist.
Set<String>	getPropertyNames() Return a set of the property names
Short	getShortProperty(String key, Short defaultValue) Return the short property value with the given key, or defaultValue if the key doesn't exist.
ConfigSourceType	getSourceType() Return the config's source type, i.e.
boolean	removeChangeListener(ConfigChangeListener listener) Remove the change listener

Method Detail

getProperty

String getProperty(String key,
                 String defaultValue)

Return the property value with the given key, or defaultValue if the key doesn't exist.

Parameters:

key - the property name

defaultValue - the default value when key is not found or any error occurred

Returns:

the property value

getIntProperty

Integer getIntProperty(String key,
                     Integer defaultValue)

Return the integer property value with the given key, or defaultValue if the key doesn't exist.

Parameters:

key - the property name

defaultValue - the default value when key is not found or any error occurred

Returns:

the property value as integer

getLongProperty

Long getLongProperty(String key,
                   Long defaultValue)

Return the long property value with the given key, or defaultValue if the key doesn't exist.

Parameters:

key - the property name

defaultValue - the default value when key is not found or any error occurred

Returns:

the property value as long

getShortProperty

Short getShortProperty(String key,
                     Short defaultValue)

Return the short property value with the given key, or defaultValue if the key doesn't exist.

Parameters:

key - the property name

defaultValue - the default value when key is not found or any error occurred

Returns:

the property value as short

getFloatProperty

Float getFloatProperty(String key,
                     Float defaultValue)

Return the float property value with the given key, or defaultValue if the key doesn't exist.

Parameters:

key - the property name

defaultValue - the default value when key is not found or any error occurred

Returns:

the property value as float

getDoubleProperty

Double getDoubleProperty(String key,
                       Double defaultValue)

Return the double property value with the given key, or defaultValue if the key doesn't exist.

Parameters:

key - the property name

defaultValue - the default value when key is not found or any error occurred

Returns:

the property value as double

getByteProperty

Byte getByteProperty(String key,
                   Byte defaultValue)

Return the byte property value with the given key, or defaultValue if the key doesn't exist.

Parameters:

key - the property name

defaultValue - the default value when key is not found or any error occurred

Returns:

the property value as byte

getBooleanProperty

Boolean getBooleanProperty(String key,
                         Boolean defaultValue)

Return the boolean property value with the given key, or defaultValue if the key doesn't exist.

Parameters:

key - the property name

defaultValue - the default value when key is not found or any error occurred

Returns:

the property value as boolean

getArrayProperty

String[] getArrayProperty(String key,
                        String delimiter,
                        String[] defaultValue)

Return the array property value with the given key, or defaultValue if the key doesn't exist.

Parameters:

key - the property name

delimiter - the delimiter regex

defaultValue - the default value when key is not found or any error occurred

getDateProperty

Date getDateProperty(String key,
                   Date defaultValue)

Return the Date property value with the given name, or defaultValue if the name doesn't exist. Will try to parse the date with Locale.US and formats as follows: yyyy-MM-dd HH:mm:ss.SSS, yyyy-MM-dd HH:mm:ss and yyyy-MM-dd

Parameters:

key - the property name

defaultValue - the default value when name is not found or any error occurred

Returns:

the property value

getDateProperty

Date getDateProperty(String key,
                   String format,
                   Date defaultValue)

Return the Date property value with the given name, or defaultValue if the name doesn't exist. Will parse the date with the format specified and Locale.US

Parameters:

key - the property name

format - the date format, see SimpleDateFormat for more information

defaultValue - the default value when name is not found or any error occurred

Returns:

the property value

getDateProperty

Date getDateProperty(String key,
                   String format,
                   Locale locale,
                   Date defaultValue)

Return the Date property value with the given name, or defaultValue if the name doesn't exist.

Parameters:

key - the property name

format - the date format, see SimpleDateFormat for more information

locale - the locale to use

defaultValue - the default value when name is not found or any error occurred

Returns:

the property value

getEnumProperty

<T extends Enum<T>> T getEnumProperty(String key,
                                    Class<T> enumType,
                                    T defaultValue)

Return the Enum property value with the given key, or defaultValue if the key doesn't exist.

Type Parameters:

T - the enum

Parameters:

key - the property name

enumType - the enum class

defaultValue - the default value when key is not found or any error occurred

Returns:

the property value

getDurationProperty

long getDurationProperty(String key,
                       long defaultValue)

Return the duration property value(in milliseconds) with the given name, or defaultValue if the name doesn't exist. Please note the format should comply with the follow example (case insensitive). Examples:

    "123MS"          -- parses as "123 milliseconds"
    "20S"            -- parses as "20 seconds"
    "15M"            -- parses as "15 minutes" (where a minute is 60 seconds)
    "10H"            -- parses as "10 hours" (where an hour is 3600 seconds)
    "2D"             -- parses as "2 days" (where a day is 24 hours or 86400 seconds)
    "2D3H4M5S123MS"  -- parses as "2 days, 3 hours, 4 minutes, 5 seconds and 123 milliseconds"
 

Parameters:

key - the property name

defaultValue - the default value when name is not found or any error occurred

Returns:

the parsed property value(in milliseconds)

addChangeListener

void addChangeListener(ConfigChangeListener listener)

Add change listener to this config instance, will be notified when any key is changed in this namespace.

Parameters:

listener - the config change listener

addChangeListener

void addChangeListener(ConfigChangeListener listener,
                     Set<String> interestedKeys)

Add change listener to this config instance, will only be notified when any of the interested keys is changed in this namespace.

Parameters:

listener - the config change listener

interestedKeys - the keys interested by the listener

Since:

1.0.0

addChangeListener

void addChangeListener(ConfigChangeListener listener,
                     Set<String> interestedKeys,
                     Set<String> interestedKeyPrefixes)

Add change listener to this config instance, will only be notified when any of the interested keys is changed in this namespace.

Parameters:

listener - the config change listener

interestedKeys - the keys that the listener is interested in

interestedKeyPrefixes - the key prefixes that the listener is interested in, e.g. "spring." means that listener is interested in keys that starts with "spring.", such as "spring.banner", "spring.jpa", etc. and "application" means that listener is interested in keys that starts with "application", such as "applicationName", "application.port", etc. For more details, see ApolloConfigChangeListener.interestedKeyPrefixes() and String.startsWith(String)

Since:

1.3.0

removeChangeListener

boolean removeChangeListener(ConfigChangeListener listener)

Remove the change listener

Parameters:

listener - the specific config change listener to remove

Returns:

true if the specific config change listener is found and removed

Since:

1.1.0

getPropertyNames

Set<String> getPropertyNames()

Return a set of the property names

Returns:

the property names

getProperty

<T> T getProperty(String key,
                com.google.common.base.Function<String,T> function,
                T defaultValue)

Return the user-defined property value with the given key, or defaultValue if the key doesn't exist.

Type Parameters:

T - user-defined type

Parameters:

key - the property name

function - the transform Function. from String to user-defined type

defaultValue - the default value when key is not found or any error occurred

Returns:

the property value

Since:

1.1.0

getSourceType

ConfigSourceType getSourceType()

Return the config's source type, i.e. where is the config loaded from

Returns:

the config's source type

Since:

1.1.0