Top Interfaces Annotations Classes Enums
[default module]

Package com.typesafe.config


Interface Summary

Modifier and TypeInterface and Description
public interface
Config

An immutable map from config paths to config values.

public interface
ConfigIncludeContext

Context provided to a ConfigIncluder; this interface is only useful inside a ConfigIncluder implementation, and is not intended for apps to implement.

public interface
ConfigIncluder

Implement this interface and provide an instance to ConfigParseOptions.setIncluder() to customize handling of include statements in config files.

public interface
ConfigIncluderClasspath

Implement this in addition to ConfigIncluder if you want to support inclusion of files with the include classpath("resource") syntax.

public interface
ConfigIncluderFile

Implement this in addition to ConfigIncluder if you want to support inclusion of files with the include file("filename") syntax.

public interface
ConfigIncluderURL

Implement this in addition to ConfigIncluder if you want to support inclusion of files with the include url("http://example.com") syntax.

public interface
ConfigList

Subtype of ConfigValue representing a list value, as in JSON's [1,2,3] syntax.

public interface
ConfigLoadingStrategy

This method allows you to alter default config loading strategy for all the code which calls ConfigFactory#load.

public interface
ConfigMergeable

Marker for types whose instances can be merged, that is Config and ConfigValue.

public interface
ConfigObject

Subtype of ConfigValue representing an object (AKA dictionary or map) value, as in JSON's curly brace { "a" : 42 } syntax.

public interface
ConfigOrigin

Represents the origin (such as filename and line number) of a ConfigValue for use in error messages.

public interface
ConfigParseable

An opaque handle to something that can be parsed, obtained from ConfigIncludeContext.

public interface
ConfigResolver

Implement this interface and provide an instance to ConfigResolveOptions.appendResolver() to provide custom behavior when unresolved substitutions are encountered during resolution.

public interface
ConfigValue

An immutable value, following the JSON type schema.

Annotation Summary

Modifier and TypeAnnotation and Description
public @interface
Optional

Allows an config property to be null.

Class Summary

Modifier and TypeClass and Description
public class
ConfigBeanFactory

Factory for automatically creating a Java class from a Config.

public abstract class
ConfigException

All exceptions thrown by the library are subclasses of ConfigException.

public class
ConfigFactory

Contains static methods for creating Config instances.

public class
ConfigMemorySize

An immutable class representing an amount of memory.

public class
ConfigOriginFactory

This class contains some static factory methods for building a ConfigOrigin.

public class
ConfigParseOptions

A set of options related to parsing.

public class
ConfigRenderOptions

A set of options related to rendering a ConfigValue.

public class
ConfigResolveOptions

A set of options related to resolving substitutions.

public class
ConfigUtil

Contains static utility methods.

public class
ConfigValueFactory

This class holds some static factory methods for building ConfigValue instances.

public class
DefaultConfigLoadingStrategy

Default config loading strategy.

Enum Summary

Modifier and TypeEnum and Description
public enum
ConfigSyntax

The syntax of a character stream (JSON, HOCON aka ".conf", or Java properties).

public enum
ConfigValueType

The type of a configuration value (following the JSON type schema).