Class Configuration

java.lang.Object

com.jayway.jsonpath.Configuration

public class Configuration
extends Object

Immutable configuration object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Configuration.ConfigurationBuilder	Configuration builder
static interface	Configuration.Defaults

Field Summary

Fields

Modifier and Type	Field	Description
private static Configuration.Defaults	DEFAULTS
private final Collection<EvaluationListener>	evaluationListeners
private final JsonProvider	jsonProvider
private final MappingProvider	mappingProvider
private final Set<Option>	options

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Configuration(JsonProvider jsonProvider, MappingProvider mappingProvider, EnumSet<Option> options, Collection<EvaluationListener> evaluationListeners)

Method Summary

Modifier and Type	Method	Description
Configuration	addEvaluationListeners(EvaluationListener... evaluationListener)	Creates a new Configuration by the provided evaluation listeners to the current listeners
Configuration	addOptions(Option... options)	Creates a new configuration by adding the new options to the options used in this configuration.
static Configuration.ConfigurationBuilder	builder()	Returns a new ConfigurationBuilder
boolean	containsOption(Option option)	Check if this configuration contains the given option
static Configuration	defaultConfiguration()	Creates a new configuration based on default values
private static Configuration.Defaults	getEffectiveDefaults()
Collection<EvaluationListener>	getEvaluationListeners()	Returns the evaluation listeners registered in this configuration
Set<Option>	getOptions()	Returns the options used by this configuration
JsonProvider	jsonProvider()	Returns JsonProvider used by this configuration
Configuration	jsonProvider(JsonProvider newJsonProvider)	Creates a new Configuration based on the given JsonProvider
MappingProvider	mappingProvider()	Returns MappingProvider used by this configuration
Configuration	mappingProvider(MappingProvider newMappingProvider)	Creates a new Configuration based on the given MappingProvider
static void	setDefaults(Configuration.Defaults defaults)	Set Default configuration
Configuration	setEvaluationListeners(EvaluationListener... evaluationListener)	Creates a new Configuration with the provided evaluation listeners
Configuration	setOptions(Option... options)	Creates a new configuration with the provided options.

Methods inherited from class Object

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

Field Details

DEFAULTS

private static Configuration.Defaults DEFAULTS

jsonProvider

private final JsonProvider jsonProvider

mappingProvider

private final MappingProvider mappingProvider

options

private final Set<Option> options

evaluationListeners

private final Collection<EvaluationListener> evaluationListeners

Constructor Details

Configuration

private Configuration(JsonProvider jsonProvider,
 MappingProvider mappingProvider,
 EnumSet<Option> options,
 Collection<EvaluationListener> evaluationListeners)

Method Details

setDefaults

public static void setDefaults(Configuration.Defaults defaults)

Set Default configuration

Parameters:

defaults - default configuration settings

getEffectiveDefaults

private static Configuration.Defaults getEffectiveDefaults()

addEvaluationListeners

public Configuration addEvaluationListeners(EvaluationListener... evaluationListener)

Creates a new Configuration by the provided evaluation listeners to the current listeners

Parameters:

evaluationListener - listeners

Returns:

a new configuration

setEvaluationListeners

public Configuration setEvaluationListeners(EvaluationListener... evaluationListener)

Creates a new Configuration with the provided evaluation listeners

Parameters:

evaluationListener - listeners

Returns:

a new configuration

getEvaluationListeners

public Collection<EvaluationListener> getEvaluationListeners()

Returns the evaluation listeners registered in this configuration

Returns:

the evaluation listeners

jsonProvider

public Configuration jsonProvider(JsonProvider newJsonProvider)

Creates a new Configuration based on the given JsonProvider

Parameters:

newJsonProvider - json provider to use in new configuration

Returns:

a new configuration

jsonProvider

public JsonProvider jsonProvider()

Returns JsonProvider used by this configuration

Returns:

jsonProvider used

mappingProvider

public Configuration mappingProvider(MappingProvider newMappingProvider)

Creates a new Configuration based on the given MappingProvider

Parameters:

newMappingProvider - mapping provider to use in new configuration

Returns:

a new configuration

mappingProvider

public MappingProvider mappingProvider()

Returns MappingProvider used by this configuration

Returns:

mappingProvider used

addOptions

public Configuration addOptions(Option... options)

Creates a new configuration by adding the new options to the options used in this configuration.

Parameters:

options - options to add

Returns:

a new configuration

setOptions

public Configuration setOptions(Option... options)

Creates a new configuration with the provided options. Options in this configuration are discarded.

Parameters:

options -

Returns:

getOptions

public Set<Option> getOptions()

Returns the options used by this configuration

Returns:

containsOption

public boolean containsOption(Option option)

Check if this configuration contains the given option

Parameters:

option - option to check

Returns:

true if configurations contains option

defaultConfiguration

public static Configuration defaultConfiguration()

Creates a new configuration based on default values

Returns:

a new configuration based on defaults

builder

public static Configuration.ConfigurationBuilder builder()

Returns a new ConfigurationBuilder

Returns:

a builder