Package com.exedio.cope.util

Class Properties

java.lang.Object

com.exedio.cope.util.Properties

Direct Known Subclasses:

DispatcherProperties, FactoryProperties, PoolProperties, SamplerProperties, VaultProperties

public class Properties
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Properties.Factory<T extends Properties>
class	Properties.Field<E>
static interface	Properties.Probe	Declares a method to be a probe.
static class	Properties.ProbeAbortedException
static class	Properties.PropertiesField<T extends Properties>
static interface	Properties.Source

Field Summary

Fields

Modifier and Type	Field	Description
static Properties.Source	EMPTY_SOURCE	Deprecated. Use Sources.EMPTY instead
static Properties.Source	SYSTEM_PROPERTY_SOURCE	Deprecated. Use Sources.SYSTEM_PROPERTIES instead

Constructor Summary

Constructors

Constructor	Description
Properties(Properties.Source source)
Properties(Properties.Source source, Properties.Source context)	Deprecated. Use Properties(Source) instead.
Properties(Properties source, String sourceDescription)	Deprecated. Use Properties(Source, Source) instead.
Properties(Properties source, String sourceDescription, Properties.Source context)	Deprecated. Use Properties(Source, Source) instead.

Method Summary

Modifier and Type	Method	Description
void	ensureEquality(Properties other)
void	ensureValidity(String... prefixes)
protected Properties.Field<Boolean>	field(String key, boolean defaultValue)	Deprecated. Use value(String, boolean) instead
protected Properties.Field<Integer>	field(String key, int defaultValue, int minimum)	Deprecated. Use value(String, int, int) instead
protected Properties.Field<Day>	field(String key, Day defaultValue)	Deprecated. Use value(String, Day) instead
protected <T extends Properties> Properties.PropertiesField<T>	field(String key, Properties.Factory<T> factory)	Deprecated. Use value(String, Factory) instead
protected Properties.Field<String>	field(String key, String defaultValue)	Deprecated. Use value(String, String) instead
protected Properties.Field<File>	fieldFile(String key)	Deprecated. Use valueFile(String) instead
Properties.Source	getContext()
String	getContext(String key)	Deprecated. Use getContext() instead.
static Properties.Source	getContext(Properties properties, String description)	Deprecated. Use getSource(java.util.Properties,String) instead
Properties.Field<?>	getField(String key)
List<Properties.Field<?>>	getFields()
Set<String>	getOrphanedKeys()
List<? extends Callable<?>>	getProbes()	Returns all probes of this properties instance.
String	getSource()
static Properties.Source	getSource(File file)	Deprecated. Use Sources.load(File) instead.
static Properties.Source	getSource(Properties properties, String description)	Deprecated. Use Sources.view(java.util.Properties, String) instead.
Properties.Source	getSourceObject()
static Properties.Source	getSystemPropertyContext()	Deprecated. Use Sources.SYSTEM_PROPERTIES instead
static Properties.Source	getSystemPropertySource()	Deprecated. Use Sources.SYSTEM_PROPERTIES instead
List<? extends Callable<?>>	getTests()	Deprecated. Use Properties.Probe instead
static Properties	loadProperties(File file)	Deprecated. Use Sources.loadProperties(File) instead.
protected IllegalPropertiesException	newException(String key, String detail)
protected IllegalPropertiesException	newException(String key, String detail, Throwable cause)
protected Properties.ProbeAbortedException	newProbeAbortedException(String message)
protected <T extends Properties> T	valnp(String key, Properties.Factory<T> factory)	Replacement for value(String, Factory) to avoid javac problem:
protected boolean	value(String key, boolean defaultValue)
protected <T extends Properties> T	value(String key, boolean enabledDefault, Properties.Factory<T> factory)
protected int	value(String key, int defaultValue, int minimum)
protected Day	value(String key, Day defaultValue)
protected <T extends Properties> T	value(String key, Properties.Factory<T> factory)	If calling this method causes javac problem: error: reference to value is ambiguous, use valnp(String, Factory) instead.
protected <E extends Enum<E>> E	value(String key, E defaultValue)
protected <E extends Enum<E>> E	value(String key, Class<E> valueClass)
protected String	value(String key, String defaultValue)
protected Charset	value(String key, Charset defaultValue)
protected Duration	value(String key, Duration defaultValue, Duration minimum)
protected Duration	value(String key, Duration defaultValue, Duration minimum, Duration maximum)
protected ZoneId	value(String key, ZoneId defaultValue)
protected File	valueFile(String key)
protected String	valueHidden(String key, String defaultValue)
protected MessageDigestFactory	valueMessageDigest(String key, String defaultValue)
protected Path	valuePath(String key)
protected <T,P> ServiceFactory<T,P>	valueService(String key, Class<? extends T> defaultValue, Class<T> superclass, Class<P> parameterType)
protected <T,P> ServiceFactory<T,P>	valueService(String key, Class<T> superclass, Class<P> parameterType)	Implementations of superclass to be instantiated by ServiceFactory.newInstance(Object) must have a suitable constructor: The type of the first parameter is specified by parameter parameterType of this method.
protected <T,P> ServiceFactory<T,P>	valueService(String key, String defaultValue, Class<T> superclass, Class<P> parameterType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_SOURCE

@Deprecated
public static final Properties.Source EMPTY_SOURCE

Deprecated.

Use Sources.EMPTY instead

SYSTEM_PROPERTY_SOURCE

@Deprecated
public static final Properties.Source SYSTEM_PROPERTY_SOURCE

Deprecated.

Use Sources.SYSTEM_PROPERTIES instead

Constructor Detail

Properties

public Properties(Properties.Source source)

Properties

@Deprecated
public Properties(Properties.Source source,
                  Properties.Source context)

Deprecated.

Use Properties(Source) instead. Using context is deprecated at all.

Properties

@Deprecated
public Properties(Properties source,
                  String sourceDescription)

Deprecated.

Use Properties(Source, Source) instead.

Properties

@Deprecated
public Properties(Properties source,
                  String sourceDescription,
                  Properties.Source context)

Deprecated.

Use Properties(Source, Source) instead.

Method Detail

getTests

@Deprecated
public List<? extends Callable<?>> getTests()

Deprecated.

Use Properties.Probe instead

This default implementation returns getProbes().

getField

public final Properties.Field<?> getField(String key)

getFields

public final List<Properties.Field<?>> getFields()

getSourceObject

public final Properties.Source getSourceObject()

getSource

public final String getSource()

getContext

public final Properties.Source getContext()

Throws:

IllegalStateException - if there is no context for these properties.

value

protected final boolean value(String key,
                              boolean defaultValue)

field

@Deprecated
protected final Properties.Field<Boolean> field(String key,
                                                boolean defaultValue)

Deprecated.

Use value(String, boolean) instead

value

protected final int value(String key,
                          int defaultValue,
                          int minimum)

field

@Deprecated
protected final Properties.Field<Integer> field(String key,
                                                int defaultValue,
                                                int minimum)

Deprecated.

Use value(String, int, int) instead

value

protected final Day value(String key,
                          Day defaultValue)

field

@Deprecated
protected final Properties.Field<Day> field(String key,
                                            Day defaultValue)

Deprecated.

Use value(String, Day) instead

value

protected final String value(String key,
                             String defaultValue)

valueHidden

protected final String valueHidden(String key,
                                   String defaultValue)

field

@Deprecated
protected final Properties.Field<String> field(String key,
                                               String defaultValue)

Deprecated.

Use value(String, String) instead

valuePath

protected final Path valuePath(String key)

valueFile

protected final File valueFile(String key)

fieldFile

@Deprecated
protected final Properties.Field<File> fieldFile(String key)

Deprecated.

Use valueFile(String) instead

value

protected final <E extends Enum<E>> E value(String key,
                                            Class<E> valueClass)

value

protected final <E extends Enum<E>> E value(String key,
                                            E defaultValue)

value

protected final Charset value(String key,
                              Charset defaultValue)

value

protected final ZoneId value(String key,
                             ZoneId defaultValue)

value

protected final Duration value(String key,
                               Duration defaultValue,
                               Duration minimum)

value

protected final Duration value(String key,
                               Duration defaultValue,
                               Duration minimum,
                               Duration maximum)

valueMessageDigest

protected final MessageDigestFactory valueMessageDigest(String key,
                                                        String defaultValue)

valueService

protected final <T,P> ServiceFactory<T,P> valueService(String key,
                                                                   Class<T> superclass,
                                                                   Class<P> parameterType)

Implementations of superclass to be instantiated by ServiceFactory.newInstance(Object) must have a suitable constructor: The type of the first parameter is specified by parameter parameterType of this method. The type of the second parameter is specified by annotation @ServiceProperties at the implementation class. If there is no such annotation, the constructor must have one parameter only. Please note that @ServiceProperties could be inherited from a superclass.

valueService

protected final <T,P> ServiceFactory<T,P> valueService(String key,
                                                                   Class<? extends T> defaultValue,
                                                                   Class<T> superclass,
                                                                   Class<P> parameterType)

valueService

protected final <T,P> ServiceFactory<T,P> valueService(String key,
                                                                   String defaultValue,
                                                                   Class<T> superclass,
                                                                   Class<P> parameterType)

value

protected final <T extends Properties> T value(String key,
                                               Properties.Factory<T> factory)

If calling this method causes javac problem: error: reference to value is ambiguous, use valnp(String, Factory) instead.

valnp

protected final <T extends Properties> T valnp(String key,
                                               Properties.Factory<T> factory)

Replacement for value(String, Factory) to avoid javac problem:

error: reference to value is ambiguous

https://bugs.java.com/bugdatabase/view_bug.do?bug_id=JDK-8170842

value

protected final <T extends Properties> T value(String key,
                                               boolean enabledDefault,
                                               Properties.Factory<T> factory)

field

@Deprecated
protected final <T extends Properties> Properties.PropertiesField<T> field(String key,
                                                                           Properties.Factory<T> factory)

Deprecated.

Use value(String, Factory) instead

newException

protected final IllegalPropertiesException newException(String key,
                                                        String detail)

newException

protected final IllegalPropertiesException newException(String key,
                                                        String detail,
                                                        Throwable cause)

getOrphanedKeys

public final Set<String> getOrphanedKeys()

ensureValidity

public final void ensureValidity(String... prefixes)

ensureEquality

public final void ensureEquality(Properties other)

newProbeAbortedException

protected final Properties.ProbeAbortedException newProbeAbortedException(String message)

getProbes

public final List<? extends Callable<?>> getProbes()

Returns all probes of this properties instance. Probes are methods annotated by Properties.Probe. The result includes probes of super classes and probes of nested properties.

See Also:

getTests()

getContext

@Deprecated
public final String getContext(String key)

Deprecated.

Use getContext() instead.

Throws:

IllegalArgumentException - if the context does not contain a value for key.

IllegalStateException - if there is no context for these properties.

getSystemPropertySource

@Deprecated
public static final Properties.Source getSystemPropertySource()

Deprecated.

Use Sources.SYSTEM_PROPERTIES instead

getSystemPropertyContext

@Deprecated
public static final Properties.Source getSystemPropertyContext()

Deprecated.

Use Sources.SYSTEM_PROPERTIES instead

getContext

@Deprecated
public static final Properties.Source getContext(Properties properties,
                                                 String description)

Deprecated.

Use getSource(java.util.Properties,String) instead

getSource

@Deprecated
public static final Properties.Source getSource(Properties properties,
                                                String description)

Deprecated.

Use Sources.view(java.util.Properties, String) instead.

getSource

@Deprecated
public static final Properties.Source getSource(File file)

Deprecated.

Use Sources.load(File) instead.

loadProperties

@Deprecated
public static final Properties loadProperties(File file)

Deprecated.

Use Sources.loadProperties(File) instead.