net.obvj.confectory.source

Class AbstractSource<T>

java.lang.Object

net.obvj.confectory.source.AbstractSource<T>

Type Parameters:

T - the configuration data type returned by this Source

All Implemented Interfaces:

Source<T>

Direct Known Subclasses:

ClasspathFileSource, DynamicSource, FileSource, StringSource

public abstract class AbstractSource<T>
extends Object
implements Source<T>

An abstract configuration source, with common infrastructure.

Since:

0.1.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Indicates whether some other object is "equal to" this one.
int	hashCode()
Optional<T>	load(Mapper<T> mapper, boolean optional) Applies a specific configuration loading strategy and returns an Optional, possibly containing the retrieved data.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.obvj.confectory.source.Source

load

Method Detail

load

public Optional<T> load(Mapper<T> mapper,
                        boolean optional)

Description copied from interface: Source

Applies a specific configuration loading strategy and returns an Optional, possibly containing the retrieved data. If the optional parameter is true and the operation fails, then Optional.empty() is returned.

Specified by:

load in interface Source<T>

Parameters:

mapper - the Mapper to be applied on the source input stream

optional - a flag indicating whether or not an exception should be thrown in an event of failure to load the configuration source

Returns:

the loaded configuration data, or an empty object in an event of failure with the optional flag set as true

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Indicates whether some other object is "equal to" this one.

Two Source objects can be considered equal if both share the same implementation and parameter/path.

Overrides:

equals in class Object

Parameters:

other - the other object with which to compare

Returns:

true if this object is the same as the one specified in the argument; false otherwise.

toString

public String toString()

Overrides:

toString in class Object