org.elasticsearch.common.settings.loader

Class SettingsLoaderFactory

java.lang.Object

org.elasticsearch.common.settings.loader.SettingsLoaderFactory

public final class SettingsLoaderFactory
extends java.lang.Object

A class holding factory methods for settings loaders that attempts to infer the type of the underlying settings content.

Method Summary

Modifier and Type	Method and Description
static SettingsLoader	loaderFromResource(java.lang.String resourceName) Returns a SettingsLoader based on the source resource name.
static SettingsLoader	loaderFromSource(java.lang.String source) Deprecated. use loaderFromXContentType(XContentType) instead
static SettingsLoader	loaderFromXContentType(XContentType xContentType) Returns a SettingsLoader based on the XContentType.

Methods inherited from class java.lang.Object

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

Method Detail

loaderFromResource

public static SettingsLoader loaderFromResource(java.lang.String resourceName)

Returns a SettingsLoader based on the source resource name. This factory method assumes that if the resource name ends with ".json" then the content should be parsed as JSON, else if the resource name ends with ".yml" or ".yaml" then the content should be parsed as YAML, otherwise throws an exception. Note that the parsers returned by this method will not accept null-valued keys.

Parameters:

resourceName - The resource name containing the settings content.

Returns:

A settings loader.

loaderFromSource

@Deprecated
public static SettingsLoader loaderFromSource(java.lang.String source)

Deprecated. use loaderFromXContentType(XContentType) instead

Returns a SettingsLoader based on the source content. This factory method assumes that if the underlying content contains an opening and closing brace ('{' and '}') then the content should be parsed as JSON, else if the underlying content fails this condition but contains a ':' then the content should be parsed as YAML, and otherwise throws an exception. Note that the JSON and YAML parsers returned by this method will accept null-valued keys.

Parameters:

source - The underlying settings content.

Returns:

A settings loader.

loaderFromXContentType

public static SettingsLoader loaderFromXContentType(XContentType xContentType)

Returns a SettingsLoader based on the XContentType. Note only XContentType.JSON and XContentType.YAML are supported

Parameters:

xContentType - The content type

Returns:

A settings loader.