net.openhft.chronicle.wire.utils

Enum ConfigLoader

java.lang.Object

java.lang.Enum<ConfigLoader>

net.openhft.chronicle.wire.utils.ConfigLoader

All Implemented Interfaces:

Serializable, Comparable<ConfigLoader>

public enum ConfigLoader
extends Enum<ConfigLoader>

Utility class for loading configuration files in YAML format. The class provides methods to load configuration files in YAML format from the classpath and convert them to Java objects. The class will replace tokens in the format ${property} within strings with System properties or supplied properties.

Files must be in YAML format that conform to WireType.TEXT. For example:

   !SimpleConfig {
      name: "some name",
      value: 10,
   }
 

The class must be fully qualified or added to the ClassAliasPool to enable the conversion.

  ClassAliasPool.CLASS_ALIASES.addAlias(SimpleConfig.class);
 

Method Summary

Modifier and Type	Method and Description
static <T> T	load(String fileAsString)
static String	loadFile(Class<?> classLoader, String filename)
static <T> T	loadFromFile(Class<?> classLoader, String filename)
static <T> T	loadFromFile(Class<?> classLoader, String filename, Properties properties)
static <T> T	loadFromFile(String filename)
static <T> T	loadFromFile(String filename, Properties properties)
static <T> T	loadWithProperties(String fileAsString, Properties properties)
static ConfigLoader	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConfigLoader[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static ConfigLoader[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConfigLoader c : ConfigLoader.values())
    System.out.println(c);

Returns:

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

valueOf

public static ConfigLoader valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

loadFile

public static String loadFile(Class<?> classLoader,
                              String filename)
                       throws IOException

Throws:

IOException

loadFromFile

public static <T> T loadFromFile(String filename)
                          throws IOException

Throws:

IOException

loadFromFile

public static <T> T loadFromFile(Class<?> classLoader,
                                 String filename)
                          throws IOException

Throws:

IOException

loadFromFile

public static <T> T loadFromFile(String filename,
                                 Properties properties)
                          throws IOException

Throws:

IOException

loadFromFile

public static <T> T loadFromFile(Class<?> classLoader,
                                 String filename,
                                 Properties properties)
                          throws IOException

Throws:

IOException

load

public static <T> T load(String fileAsString)

loadWithProperties

public static <T> T loadWithProperties(String fileAsString,
                                       Properties properties)