C D E F G I J L M O P R S T U V W X Y

C

com.alanbuttars.commons.config - package com.alanbuttars.commons.config

com.alanbuttars.commons.config.event - package com.alanbuttars.commons.config.event

com.alanbuttars.commons.config.eventbus - package com.alanbuttars.commons.config.eventbus

com.alanbuttars.commons.config.master - package com.alanbuttars.commons.config.master

com.alanbuttars.commons.config.poll - package com.alanbuttars.commons.config.poll

com.alanbuttars.commons.config.stub - package com.alanbuttars.commons.config.stub

config() - Static method in class com.alanbuttars.commons.config.stub.Watch

Creates an instance of this class, using the system property commons.config.

config(String) - Static method in class com.alanbuttars.commons.config.stub.Watch

Creates an instance of this class, using the given file path.

Configuration<T> - Interface in com.alanbuttars.commons.config

Models a configuration object with the flexibility to return multiple configuration value types.

ConfigurationAbstractImpl<T> - Class in com.alanbuttars.commons.config

Abstract implementation of Configuration which defines the logic by which event subscription works.

ConfigurationAbstractImpl(String, EventBus) - Constructor for class com.alanbuttars.commons.config.ConfigurationAbstractImpl

ConfigurationClientsImpl - Class in com.alanbuttars.commons.config

ConfigurationClientsImpl(String, File, EventBus) - Constructor for class com.alanbuttars.commons.config.ConfigurationClientsImpl

ConfigurationDirectoryImpl - Class in com.alanbuttars.commons.config

Configuration implementation used for directories.

ConfigurationDirectoryImpl(String, File, EventBus) - Constructor for class com.alanbuttars.commons.config.ConfigurationDirectoryImpl

ConfigurationJsonCollectionImpl<C> - Class in com.alanbuttars.commons.config

Configuration implementation used for JSON files.

ConfigurationJsonCollectionImpl(String, File, EventBus, TypeReference<C>) - Constructor for class com.alanbuttars.commons.config.ConfigurationJsonCollectionImpl

ConfigurationJsonImpl<T> - Class in com.alanbuttars.commons.config

Configuration implementation used for JSON files.

ConfigurationJsonImpl(String, File, EventBus, Class<T>) - Constructor for class com.alanbuttars.commons.config.ConfigurationJsonImpl

ConfigurationPropertiesImpl - Class in com.alanbuttars.commons.config

Configuration implementation used for Java .properties files

ConfigurationPropertiesImpl(String, File, EventBus) - Constructor for class com.alanbuttars.commons.config.ConfigurationPropertiesImpl

ConfigurationXmlImpl<T> - Class in com.alanbuttars.commons.config

Configuration implementation used for XML files.

ConfigurationXmlImpl(String, File, EventBus, Class<T>) - Constructor for class com.alanbuttars.commons.config.ConfigurationXmlImpl

ConfigurationYamlCollectionImpl<C> - Class in com.alanbuttars.commons.config

Configuration implementation used for YAML files.

ConfigurationYamlCollectionImpl(String, File, EventBus, TypeReference<C>) - Constructor for class com.alanbuttars.commons.config.ConfigurationYamlCollectionImpl

ConfigurationYamlImpl<T> - Class in com.alanbuttars.commons.config

Configuration implementation used for YAML files.

ConfigurationYamlImpl(String, File, EventBus, Class<T>) - Constructor for class com.alanbuttars.commons.config.ConfigurationYamlImpl

custom(String) - Method in class com.alanbuttars.commons.config.stub.Watch

Creates a custom configuration object.

CustomConfigurationParams - Class in com.alanbuttars.commons.config.stub

A simple POJO containing params used to create a custom Configuration.

D

directory(String) - Method in class com.alanbuttars.commons.config.stub.Watch

Creates a configuration object from a directory.

DirectoryFileEvent - Class in com.alanbuttars.commons.config.event

Models an event thrown when a directory change is detected.

DirectoryFileEvent(String, File, File, FileEventType) - Constructor for class com.alanbuttars.commons.config.event.DirectoryFileEvent

DirectoryPoll - Class in com.alanbuttars.commons.config.poll

Models a runnable task which continually checks a given directory to see if the files within it have been changed.

DirectoryPoll(String, File, EventBus) - Constructor for class com.alanbuttars.commons.config.poll.DirectoryPoll

E

Event - Interface in com.alanbuttars.commons.config.event

Models an event published by EventBus.

EventBus - Interface in com.alanbuttars.commons.config.eventbus

Models a simple event bus which supports publish-subscribe communication.

eventBus - Variable in class com.alanbuttars.commons.config.stub.WatchFileCustomImplStub

eventBus - Variable in class com.alanbuttars.commons.config.stub.WatchFileJsonImplStub

eventBus - Variable in class com.alanbuttars.commons.config.stub.WatchFileXmlImplStub

eventBus - Variable in class com.alanbuttars.commons.config.stub.WatchFileYamlImplStub

EventBusAsyncImpl - Class in com.alanbuttars.commons.config.eventbus

Implements the EventBus interface by utilizing Google Guava's asynchronous AsyncEventBus.

EventBusAsyncImpl(Executor) - Constructor for class com.alanbuttars.commons.config.eventbus.EventBusAsyncImpl

See AsyncEventBus.AsyncEventBus(Executor).

EventBusAsyncImpl(Executor, String) - Constructor for class com.alanbuttars.commons.config.eventbus.EventBusAsyncImpl

See AsyncEventBus.AsyncEventBus(String, Executor).

EventBusAsyncImpl(Executor, SubscriberExceptionHandler) - Constructor for class com.alanbuttars.commons.config.eventbus.EventBusAsyncImpl

See AsyncEventBus.AsyncEventBus(Executor, SubscriberExceptionHandler).

EventBusSyncImpl - Class in com.alanbuttars.commons.config.eventbus

Implements the EventBus interface by utilizing Google Guava's synchronous EventBus.

EventBusSyncImpl() - Constructor for class com.alanbuttars.commons.config.eventbus.EventBusSyncImpl

See EventBus.EventBus().

EventBusSyncImpl(String) - Constructor for class com.alanbuttars.commons.config.eventbus.EventBusSyncImpl

See EventBus.EventBus(String).

EventBusSyncImpl(SubscriberExceptionHandler) - Constructor for class com.alanbuttars.commons.config.eventbus.EventBusSyncImpl

See EventBus.EventBus(SubscriberExceptionHandler).

F

file - Variable in class com.alanbuttars.commons.config.stub.WatchFileCustomImplStub

file - Variable in class com.alanbuttars.commons.config.stub.WatchFileJsonImplStub

file - Variable in class com.alanbuttars.commons.config.stub.WatchFileXmlImplStub

file - Variable in class com.alanbuttars.commons.config.stub.WatchFileYamlImplStub

file - Variable in class com.alanbuttars.commons.config.stub.WatchFileYamlTypeReferenceImplStub

FileEvent - Class in com.alanbuttars.commons.config.event

Models an event thrown when a file change is detected.

FileEvent(String, File, FileEventType) - Constructor for class com.alanbuttars.commons.config.event.FileEvent

FileEventType - Enum in com.alanbuttars.commons.config.event

Enumerated types for FileEvent.

FilePoll - Class in com.alanbuttars.commons.config.poll

Models a runnable task which continually checks a given file to see if it has been changed.

FilePoll(String, File, EventBus) - Constructor for class com.alanbuttars.commons.config.poll.FilePoll

G

getBoolean(String, boolean) - Method in class com.alanbuttars.commons.config.ConfigurationPropertiesImpl

Retrieves the boolean configuration value associated with the given key, or the defaultValue if no value was configured.

getByte(String, byte) - Method in class com.alanbuttars.commons.config.ConfigurationPropertiesImpl

Retrieves the byte configuration value associated with the given key, or the defaultValue if no value was configured.

getChar(String, char) - Method in class com.alanbuttars.commons.config.ConfigurationPropertiesImpl

Retrieves the char configuration value associated with the given key, or the defaultValue if no value was configured.

getDirectory() - Method in class com.alanbuttars.commons.config.event.DirectoryFileEvent

getDouble(String, double) - Method in class com.alanbuttars.commons.config.ConfigurationPropertiesImpl

Retrieves the double configuration value associated with the given key, or the defaultValue if no value was configured.

getEventBus() - Method in class com.alanbuttars.commons.config.ConfigurationAbstractImpl

getEventBus() - Method in class com.alanbuttars.commons.config.eventbus.EventBusAsyncImpl

getEventBus() - Method in class com.alanbuttars.commons.config.eventbus.EventBusSyncImpl

getEventBus() - Method in class com.alanbuttars.commons.config.stub.CustomConfigurationParams

getExecutor() - Method in class com.alanbuttars.commons.config.stub.Watch

getFile() - Method in class com.alanbuttars.commons.config.event.FileEvent

getFile() - Method in class com.alanbuttars.commons.config.master.YamlFileConfig

getFile() - Method in class com.alanbuttars.commons.config.stub.CustomConfigurationParams

getFileConfigs() - Method in class com.alanbuttars.commons.config.master.YamlConfig

getFileEventType() - Method in class com.alanbuttars.commons.config.event.FileEvent

getFloat(String, float) - Method in class com.alanbuttars.commons.config.ConfigurationPropertiesImpl

Retrieves the float configuration value associated with the given key, or the defaultValue if no value was configured.

getInt(String, int) - Method in class com.alanbuttars.commons.config.ConfigurationPropertiesImpl

Retrieves the int configuration value associated with the given key, or the defaultValue if no value was configured.

getLong(String, long) - Method in class com.alanbuttars.commons.config.ConfigurationPropertiesImpl

Retrieves the long configuration value associated with the given key, or the defaultValue if no value was configured.

getMaster() - Method in class com.alanbuttars.commons.config.master.YamlConfig

getPollEvery() - Method in class com.alanbuttars.commons.config.master.YamlFileConfig

getPollEvery() - Method in class com.alanbuttars.commons.config.master.YamlMasterConfig

getPollEveryUnit() - Method in class com.alanbuttars.commons.config.master.YamlFileConfig

getPollEveryUnit() - Method in class com.alanbuttars.commons.config.master.YamlMasterConfig

getPollEveryUnitString() - Method in class com.alanbuttars.commons.config.master.YamlFileConfig

getPollEveryUnitString() - Method in class com.alanbuttars.commons.config.master.YamlMasterConfig

getPoolSize() - Method in class com.alanbuttars.commons.config.master.YamlMasterConfig

getShort(String, short) - Method in class com.alanbuttars.commons.config.ConfigurationPropertiesImpl

Retrieves the short configuration value associated with the given key, or the defaultValue if no value was configured.

getSourceId() - Method in class com.alanbuttars.commons.config.ConfigurationAbstractImpl

getSourceId() - Method in class com.alanbuttars.commons.config.event.FileEvent

getSourceId() - Method in class com.alanbuttars.commons.config.stub.CustomConfigurationParams

getString(String, String) - Method in class com.alanbuttars.commons.config.ConfigurationPropertiesImpl

Retrieves the String configuration value associated with the given key, or the defaultValue if no value was configured.

getValue() - Method in class com.alanbuttars.commons.config.ConfigurationAbstractImpl

Returns the configuration object.

getValue(String, Function<String, V>) - Method in class com.alanbuttars.commons.config.ConfigurationPropertiesImpl

Retrieves the configuration value associated with the given key by transforming the value using the valueMappingFunction.

getValue(String) - Method in class com.alanbuttars.commons.config.ConfigurationPropertiesImpl

Fetches the configuration value.

I

init(File) - Method in class com.alanbuttars.commons.config.ConfigurationAbstractImpl

Initializes the configuration ConfigurationAbstractImpl.value and subscribes this object to file changes.

J

json(String) - Method in class com.alanbuttars.commons.config.stub.Watch

Creates a configuration object from a JSON file.

L

load(File) - Method in interface com.alanbuttars.commons.config.Configuration

Loads the configuration object from the configuration file.

load(File) - Method in class com.alanbuttars.commons.config.ConfigurationClientsImpl

load(File) - Method in class com.alanbuttars.commons.config.ConfigurationDirectoryImpl

load(File) - Method in class com.alanbuttars.commons.config.ConfigurationJsonCollectionImpl

load(File) - Method in class com.alanbuttars.commons.config.ConfigurationJsonImpl

load(File) - Method in class com.alanbuttars.commons.config.ConfigurationPropertiesImpl

load(File) - Method in class com.alanbuttars.commons.config.ConfigurationXmlImpl

load(File) - Method in class com.alanbuttars.commons.config.ConfigurationYamlCollectionImpl

load(File) - Method in class com.alanbuttars.commons.config.ConfigurationYamlImpl

M

mappedTo(Class<T>) - Method in class com.alanbuttars.commons.config.stub.WatchFileJsonImplStub

Instructs the configuration object to map the contents of the JSON file to an object of the given type.

mappedTo(TypeReference<C>) - Method in class com.alanbuttars.commons.config.stub.WatchFileJsonImplStub

Instructs the configuration object to map the contents of the JSON file to an object of the given type reference.

mappedTo(Class<T>) - Method in class com.alanbuttars.commons.config.stub.WatchFileXmlImplStub

Instructs the configuration object to map the contents of the XML file to an object of the given type.

mappedTo(Class<T>) - Method in class com.alanbuttars.commons.config.stub.WatchFileYamlImplStub

Instructs the configuration object to map the contents of the YAML file to an object of the given type.

mappedTo(TypeReference<C>) - Method in class com.alanbuttars.commons.config.stub.WatchFileYamlImplStub

Instructs the configuration object to map the contents of the YAML file to an object of the given type reference.

mappedWith(Function<CustomConfigurationParams, C>) - Method in class com.alanbuttars.commons.config.stub.WatchFileCustomImplStub

Uses the given function to transform configuration params into a defined Configuration.

O

onFileEvent(FileEvent) - Method in class com.alanbuttars.commons.config.ConfigurationAbstractImpl

Called when a file event published from the ConfigurationAbstractImpl.eventBus is heard.

onFileEvent(FileEvent) - Method in class com.alanbuttars.commons.config.ConfigurationDirectoryImpl

onFileEventMatch(File, FileEventType) - Method in class com.alanbuttars.commons.config.ConfigurationAbstractImpl

Defines the reloading logic to be performed when the file event matches this configuration object.

P

postCreatedEvent(File) - Method in class com.alanbuttars.commons.config.poll.DirectoryPoll

postCreatedEvent() - Method in class com.alanbuttars.commons.config.poll.FilePoll

postDeletedEvent(File) - Method in class com.alanbuttars.commons.config.poll.DirectoryPoll

postDeletedEvent() - Method in class com.alanbuttars.commons.config.poll.FilePoll

postUpdatedEvent(File) - Method in class com.alanbuttars.commons.config.poll.DirectoryPoll

postUpdatedEvent() - Method in class com.alanbuttars.commons.config.poll.FilePoll

properties(String) - Method in class com.alanbuttars.commons.config.stub.Watch

Creates a configuration object from a properties file.

publish(E) - Method in interface com.alanbuttars.commons.config.eventbus.EventBus

Publishes an event to the event bus.

publish(E) - Method in class com.alanbuttars.commons.config.eventbus.EventBusAsyncImpl

Publishes an event to the event bus.

publish(E) - Method in class com.alanbuttars.commons.config.eventbus.EventBusSyncImpl

Publishes an event to the event bus.

R

reload(File) - Method in class com.alanbuttars.commons.config.ConfigurationAbstractImpl

reload(File) - Method in class com.alanbuttars.commons.config.stub.Watch

run() - Method in class com.alanbuttars.commons.config.poll.DirectoryPoll

run() - Method in class com.alanbuttars.commons.config.poll.FilePoll

S

setPoolSize(int) - Method in class com.alanbuttars.commons.config.master.YamlMasterConfig

SOURCE_ID - Static variable in class com.alanbuttars.commons.config.stub.Watch

sourceId - Variable in class com.alanbuttars.commons.config.stub.WatchFileCustomImplStub

sourceId - Variable in class com.alanbuttars.commons.config.stub.WatchFileJsonImplStub

sourceId - Variable in class com.alanbuttars.commons.config.stub.WatchFileXmlImplStub

sourceId - Variable in class com.alanbuttars.commons.config.stub.WatchFileYamlImplStub

sourceId - Variable in class com.alanbuttars.commons.config.stub.WatchFileYamlTypeReferenceImplStub

subscribe(Object) - Method in interface com.alanbuttars.commons.config.eventbus.EventBus

Subscribes to events published by this event bus.

subscribe(Object) - Method in class com.alanbuttars.commons.config.eventbus.EventBusAsyncImpl

Subscribes to events published by this event bus.

subscribe(Object) - Method in class com.alanbuttars.commons.config.eventbus.EventBusSyncImpl

Subscribes to events published by this event bus.

T

typeReference - Variable in class com.alanbuttars.commons.config.stub.WatchFileYamlTypeReferenceImplStub

U

unsubscribe(Object) - Method in interface com.alanbuttars.commons.config.eventbus.EventBus

Unsubscribes to events published by this event bus.

unsubscribe(Object) - Method in class com.alanbuttars.commons.config.eventbus.EventBusAsyncImpl

Unsubscribes to events published by this event bus.

unsubscribe(Object) - Method in class com.alanbuttars.commons.config.eventbus.EventBusSyncImpl

Unsubscribes to events published by this event bus.

V

validate(YamlConfig) - Static method in class com.alanbuttars.commons.config.master.YamlConfigValidator

Validates a given config.

valueOf(String) - Static method in enum com.alanbuttars.commons.config.event.FileEventType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.alanbuttars.commons.config.event.FileEventType

Returns an array containing the constants of this enum type, in the order they are declared.

W

Watch - Class in com.alanbuttars.commons.config.stub

Models the entrypoint to this module.

WatchFileCustomImplStub - Class in com.alanbuttars.commons.config.stub

Intermediate stub ultimately used to create a custom ConfigurationAbstractImpl.

WatchFileCustomImplStub(String, File, EventBus) - Constructor for class com.alanbuttars.commons.config.stub.WatchFileCustomImplStub

WatchFileJsonImplStub - Class in com.alanbuttars.commons.config.stub

Intermediate stub ultimately used to create a ConfigurationJsonImpl.

WatchFileXmlImplStub - Class in com.alanbuttars.commons.config.stub

Intermediate stub ultimately used to create a ConfigurationXmlImpl.

WatchFileYamlImplStub - Class in com.alanbuttars.commons.config.stub

Intermediate stub ultimately used to create a ConfigurationYamlImpl.

WatchFileYamlTypeReferenceImplStub<C> - Class in com.alanbuttars.commons.config.stub

Terminal stub used to create a ConfigurationYamlImpl from a YAML file which represents some collection.

WatchStub - Class in com.alanbuttars.commons.config.stub

Intermediate stub ultimately used to create a Watch.

whenConfigFileCreated(File) - Method in class com.alanbuttars.commons.config.ConfigurationAbstractImpl

Called when the file associated with this object is FileEventType.CREATED.

whenConfigFileDeleted(File) - Method in class com.alanbuttars.commons.config.ConfigurationAbstractImpl

Called when the file associated with this object is FileEventType.DELETED.

whenConfigFileDeleted(File) - Method in class com.alanbuttars.commons.config.ConfigurationDirectoryImpl

whenConfigFileUpdated(File) - Method in class com.alanbuttars.commons.config.ConfigurationAbstractImpl

Called when the file associated with this object is FileEventType.UPDATED.

withEventBus(EventBus) - Method in class com.alanbuttars.commons.config.stub.WatchFileYamlTypeReferenceImplStub

Instructs the created Configuration to subscribe to events published by the given event bus.

withEventBus(EventBus) - Method in class com.alanbuttars.commons.config.stub.WatchStub

Creates the singleton instance used to create Configuration objects.

X

xml(String) - Method in class com.alanbuttars.commons.config.stub.Watch

Creates a configuration object from a XML file.

Y

yaml(String) - Method in class com.alanbuttars.commons.config.stub.Watch

Creates a configuration object from a YAML file.

YamlConfig - Class in com.alanbuttars.commons.config.master

Object which encompasses the YAML configuration file for this module.

YamlConfig() - Constructor for class com.alanbuttars.commons.config.master.YamlConfig

YamlConfigValidator - Class in com.alanbuttars.commons.config.master

A validator object for YamlConfig.

YamlConfigValidator() - Constructor for class com.alanbuttars.commons.config.master.YamlConfigValidator

YamlFileConfig - Class in com.alanbuttars.commons.config.master

YamlFileConfig() - Constructor for class com.alanbuttars.commons.config.master.YamlFileConfig

YamlMasterConfig - Class in com.alanbuttars.commons.config.master

YamlMasterConfig() - Constructor for class com.alanbuttars.commons.config.master.YamlMasterConfig

C D E F G I J L M O P R S T U V W X Y