A B C D E F G I J L M O P R S T Y
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- add(ConfigSource) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source.
- args(String[]) - Method in interface ratpack.config.ConfigDataBuilder
-
Invokes
ConfigDataBuilder.args(String, String, String[]), with no prefix and"="as the separator. - args(String, String[]) - Method in interface ratpack.config.ConfigDataBuilder
-
Invokes
ConfigDataBuilder.args(String, String, String[]), with no prefix. - args(String, String, String[]) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for the given string args.
B
- binding(String) - Method in interface ratpack.config.FileSystemBinding
-
Construct a new binding by using the given path as a relative path from this bind point.
- build() - Method in interface ratpack.config.ConfigDataBuilder
-
Creates the config data, based on the state of this builder.
- builder() - Static method in interface ratpack.config.ConfigData
- builder(ObjectMapper) - Static method in interface ratpack.config.ConfigData
- builder(Environment) - Static method in interface ratpack.config.ConfigData
- builder(Environment, ObjectMapper) - Static method in interface ratpack.config.ConfigData
C
- ConfigData - Interface in ratpack.config
-
Configuration data for the application, potentially built from many sources.
- ConfigDataBuilder - Interface in ratpack.config
-
Configures how configuration data will be loaded and bound to objects.
- ConfigObject<T> - Interface in ratpack.config
-
An object deserialized from config.
- ConfigSource - Interface in ratpack.config
-
Allows providing custom sources of configuration data.
- configureObjectMapper(Action<ObjectMapper>) - Method in interface ratpack.config.ConfigDataBuilder
-
Configures the object mapper used for binding configuration data to arbitrary objects.
D
- DEFAULT_ENV_PREFIX - Static variable in interface ratpack.config.ConfigDataBuilder
- DEFAULT_PROP_PREFIX - Static variable in interface ratpack.config.ConfigDataBuilder
- defaultEnvironment() - Static method in interface ratpack.config.Environment
E
- env() - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for environment variables starting with the prefix "RATPACK_".
- env(String) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for environment variables starting with the specified prefix.
- env(String, Function<String, String>) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for environment variables starting with the specified prefix.
- env(EnvironmentParser) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for environment variables using custom parsing logic.
- Environment - Interface in ratpack.config
- EnvironmentParser - Interface in ratpack.config
-
Strategy for parsing a set of environment variables into a form appropriate for use in a
ConfigSource.
F
- file(String) - Method in interface ratpack.config.FileSystemBinding
-
Creates a file reference relative to the bind point denoted by the given relative path.
- FileSystemBinding - Interface in ratpack.config
-
A file system binding represents a file system location that is used to resolve relative paths.
- filter(Pair<String, String>) - Method in interface ratpack.config.EnvironmentParser
-
Provides an opportunity to remove environment variables from parsing by the remainder of the pipeline.
G
- get(Class<O>) - Method in interface ratpack.config.ConfigData
-
Binds the root of the configuration data to the specified type.
- get(String, Class<O>) - Method in interface ratpack.config.ConfigData
-
Binds a segment of the configuration data to the specified type.
- getAsConfigObject(String, TypeToken<O>) - Method in interface ratpack.config.ConfigData
-
Binds a segment of the configuration data to the specified type.
- getAsConfigObject(String, Class<O>) - Method in interface ratpack.config.ConfigData
-
Binds a segment of the configuration data to the specified type.
- getConfigSources() - Method in interface ratpack.config.ConfigDataBuilder
-
Returns the config sources used for configuration binding.
- getenv() - Method in interface ratpack.config.Environment
- getFile() - Method in interface ratpack.config.FileSystemBinding
-
The actual point on the filesystem that this binding is bound to.
- getObject() - Method in interface ratpack.config.ConfigObject
-
The bound object.
- getObjectMapper() - Method in interface ratpack.config.ConfigDataBuilder
-
Returns the object mapper used for configuration binding.
- getPath() - Method in interface ratpack.config.ConfigObject
-
The path to the config item.
- getProperties() - Method in interface ratpack.config.Environment
- getRootNode() - Method in interface ratpack.config.ConfigData
- getType() - Method in interface ratpack.config.ConfigObject
-
The raw type of the config item.
- getTypeToken() - Method in interface ratpack.config.ConfigObject
-
The complete type of the config item.
I
- isDevelopment() - Method in interface ratpack.config.Environment
J
- jacksonModules(Module...) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds
Jackson modulesto the object mapper. - json(ByteSource) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for a JSON file.
- json(String) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds the JSON file at the given path as a configuration source.
- json(URL) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for a JSON file.
- json(Path) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for a JSON file.
L
- loadConfigData(ObjectMapper, FileSystemBinding) - Method in interface ratpack.config.ConfigSource
-
Loads the configuration data from this data source.
M
- map(String) - Method in interface ratpack.config.EnvironmentParser
-
Transforms a segment.
O
- object(String, Object) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds the object's fields at the given path as a configuration source.
- of(ObjectMapper, Action<? super ConfigDataBuilder>) - Static method in interface ratpack.config.ConfigData
- of(Path) - Static method in interface ratpack.config.FileSystemBinding
- of(Environment, ObjectMapper, Action<? super ConfigDataBuilder>) - Static method in interface ratpack.config.ConfigData
-
Builds a new config data with the specified object mapper, from the given definition.
- of(Environment, Action<? super ConfigDataBuilder>) - Static method in interface ratpack.config.ConfigData
-
Builds a new config data with the default object mapper, from the given definition.
- of(Action<? super ConfigDataBuilder>) - Static method in interface ratpack.config.ConfigData
- onError(Action<? super Throwable>) - Method in interface ratpack.config.ConfigDataBuilder
-
Sets the error all that will be used for added configuration sources.
P
- PathResolver - Interface in ratpack.config
- props(ByteSource) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for a properties file.
- props(String) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds the properties file at the given path as a configuration source.
- props(URL) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for a properties file.
- props(Path) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for a properties file.
- props(Map<String, String>) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for a Map (flat key-value pairs).
- props(Properties) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for a properties object.
R
- ratpack.config - package ratpack.config
-
Provides the ability to access configuration data from a variety of sources, such as YAML, JSON, properties files, system properties, and environment variables.
- resolve(String) - Method in interface ratpack.config.PathResolver
- root() - Static method in interface ratpack.config.FileSystemBinding
S
- sysProps() - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for system properties starting with the prefix "ratpack.".
- sysProps(String) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for system properties starting with the specified prefix.
T
- tokenize(String) - Method in interface ratpack.config.EnvironmentParser
-
Splits the name of an environment variable into per-object segments.
- TYPE - Static variable in interface ratpack.config.FileSystemBinding
-
A type token for this type.
Y
- yaml(ByteSource) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for a YAML file.
- yaml(String) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds the YAML file at the given path as a configuration source.
- yaml(URL) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for a YAML file.
- yaml(Path) - Method in interface ratpack.config.ConfigDataBuilder
-
Adds a configuration source for a YAML file.
All Classes All Packages