org.apache.seatunnel.shade.com.typesafe.config

类 ConfigParseOptions

java.lang.Object

org.apache.seatunnel.shade.com.typesafe.config.ConfigParseOptions

public final class ConfigParseOptions
extends Object

A set of options related to parsing.

This object is immutable, so the "setters" return a new object.

Here is an example of creating a custom ConfigParseOptions:

     ConfigParseOptions options = ConfigParseOptions.defaults()
         .setSyntax(ConfigSyntax.JSON)
         .setAllowMissing(false)
 

字段概要

字段

限定符和类型	字段和说明
static String	PATH_TOKEN_SEPARATOR a.b.c a->b->c

方法概要

限定符和类型	方法和说明
ConfigParseOptions	appendIncluder(org.apache.seatunnel.shade.com.typesafe.config.ConfigIncluder includer) Appends a ConfigIncluder which customizes how includes are handled.
static ConfigParseOptions	defaults() Gets an instance of ConfigParseOptions with all fields set to the default values.
boolean	getAllowMissing() Gets the current "allow missing" flag.
ClassLoader	getClassLoader() Get the class loader; never returns null, if the class loader was unset, returns Thread.currentThread().getContextClassLoader().
org.apache.seatunnel.shade.com.typesafe.config.ConfigIncluder	getIncluder() Gets the current includer (will be null for the default includer).
String	getOriginDescription() Gets the current origin description, which may be null for "automatic".
org.apache.seatunnel.shade.com.typesafe.config.ConfigSyntax	getSyntax() Gets the current syntax option, which may be null for "any".
ConfigParseOptions	prependIncluder(org.apache.seatunnel.shade.com.typesafe.config.ConfigIncluder includer) Prepends a ConfigIncluder which customizes how includes are handled.
ConfigParseOptions	setAllowMissing(boolean allowMissing) Set to false to throw an exception if the item being parsed (for example a file) is missing.
ConfigParseOptions	setClassLoader(ClassLoader loader) Set the class loader.
ConfigParseOptions	setIncluder(org.apache.seatunnel.shade.com.typesafe.config.ConfigIncluder includer) Set a ConfigIncluder which customizes how includes are handled. null means to use the default includer.
ConfigParseOptions	setOriginDescription(String originDescription) Set a description for the thing being parsed.
ConfigParseOptions	setSyntax(org.apache.seatunnel.shade.com.typesafe.config.ConfigSyntax syntax) Set the file format.

从类继承的方法 java.lang.Object

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

字段详细资料

PATH_TOKEN_SEPARATOR

public static final String PATH_TOKEN_SEPARATOR

a.b.c a->b->c

另请参阅:

常量字段值

方法详细资料

defaults

public static ConfigParseOptions defaults()

Gets an instance of ConfigParseOptions with all fields set to the default values. Start with this instance and make any changes you need.

返回:

the default parse options

setSyntax

public ConfigParseOptions setSyntax(org.apache.seatunnel.shade.com.typesafe.config.ConfigSyntax syntax)

Set the file format. If set to null, try to guess from any available filename extension; if guessing fails, assume ConfigSyntax.CONF.

参数:

syntax - a syntax or null for best guess

返回:

options with the syntax set

getSyntax

public org.apache.seatunnel.shade.com.typesafe.config.ConfigSyntax getSyntax()

Gets the current syntax option, which may be null for "any".

返回:

the current syntax or null

setOriginDescription

public ConfigParseOptions setOriginDescription(String originDescription)

Set a description for the thing being parsed. In most cases this will be set up for you to something like the filename, but if you provide just an input stream you might want to improve on it. Set to null to allow the library to come up with something automatically. This description is the basis for the ConfigOrigin of the parsed values.

参数:

originDescription - description to put in the ConfigOrigin

返回:

options with the origin description set

getOriginDescription

public String getOriginDescription()

Gets the current origin description, which may be null for "automatic".

返回:

the current origin description or null

setAllowMissing

public ConfigParseOptions setAllowMissing(boolean allowMissing)

Set to false to throw an exception if the item being parsed (for example a file) is missing. Set to true to just return an empty document in that case. Note that this setting applies on only to fetching the root document, it has no effect on any nested includes.

参数:

allowMissing - true to silently ignore missing item

返回:

options with the "allow missing" flag set

getAllowMissing

public boolean getAllowMissing()

Gets the current "allow missing" flag.

返回:

whether we allow missing files

setIncluder

public ConfigParseOptions setIncluder(org.apache.seatunnel.shade.com.typesafe.config.ConfigIncluder includer)

Set a ConfigIncluder which customizes how includes are handled. null means to use the default includer.

参数:

includer - the includer to use or null for default

返回:

new version of the parse options with different includer

prependIncluder

public ConfigParseOptions prependIncluder(org.apache.seatunnel.shade.com.typesafe.config.ConfigIncluder includer)

Prepends a ConfigIncluder which customizes how includes are handled. To prepend your includer, the library calls ConfigIncluder.withFallback(org.apache.seatunnel.shade.com.typesafe.config.ConfigIncluder) on your includer to append the existing includer to it.

参数:

includer - the includer to prepend (may not be null)

返回:

new version of the parse options with different includer

appendIncluder

public ConfigParseOptions appendIncluder(org.apache.seatunnel.shade.com.typesafe.config.ConfigIncluder includer)

Appends a ConfigIncluder which customizes how includes are handled. To append, the library calls ConfigIncluder.withFallback(org.apache.seatunnel.shade.com.typesafe.config.ConfigIncluder) on the existing includer.

参数:

includer - the includer to append (may not be null)

返回:

new version of the parse options with different includer

getIncluder

public org.apache.seatunnel.shade.com.typesafe.config.ConfigIncluder getIncluder()

Gets the current includer (will be null for the default includer).

返回:

current includer or null

setClassLoader

public ConfigParseOptions setClassLoader(ClassLoader loader)

Set the class loader. If set to null, Thread.currentThread().getContextClassLoader() will be used.

参数:

loader - a class loader or null to use thread context class loader

返回:

options with the class loader set

getClassLoader

public ClassLoader getClassLoader()

Get the class loader; never returns null, if the class loader was unset, returns Thread.currentThread().getContextClassLoader().

返回:

class loader to use