com.ctrip.framework.apollo

Interface ConfigFile

All Known Subinterfaces:

PropertiesCompatibleConfigFile

All Known Implementing Classes:

AbstractConfigFile, JsonConfigFile, PlainTextConfigFile, PropertiesConfigFile, TxtConfigFile, XmlConfigFile, YamlConfigFile, YmlConfigFile

public interface ConfigFile

Author:

Jason Song(song_s@ctrip.com)

Method Summary

Methods

Modifier and Type	Method and Description
void	addChangeListener(ConfigFileChangeListener listener) Add change listener to this config file instance.
ConfigFileFormat	getConfigFileFormat() Get the file format of this config file instance
String	getContent() Get file content of the namespace
String	getNamespace() Get the namespace of this config file instance
ConfigSourceType	getSourceType() Return the config's source type, i.e.
boolean	hasContent() Whether the config file has any content
boolean	removeChangeListener(ConfigFileChangeListener listener) Remove the change listener

Method Detail

getContent

String getContent()

Get file content of the namespace

Returns:

file content, null if there is no content

hasContent

boolean hasContent()

Whether the config file has any content

Returns:

true if it has content, false otherwise.

getNamespace

String getNamespace()

Get the namespace of this config file instance

Returns:

the namespace

getConfigFileFormat

ConfigFileFormat getConfigFileFormat()

Get the file format of this config file instance

Returns:

the config file format enum

addChangeListener

void addChangeListener(ConfigFileChangeListener listener)

Add change listener to this config file instance.

Parameters:

listener - the config file change listener

removeChangeListener

boolean removeChangeListener(ConfigFileChangeListener 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

getSourceType

ConfigSourceType getSourceType()

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

Returns:

the config's source type