Package com.jayway.jsonpath
Class Configuration
- java.lang.Object
-
- com.jayway.jsonpath.Configuration
-
public class Configuration extends java.lang.Object
Immutable configuration object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Configuration.ConfigurationBuilder
Configuration builderstatic interface
Configuration.Defaults
-
Field Summary
Fields Modifier and Type Field Description private static Configuration.Defaults
DEFAULTS
private java.util.Collection<EvaluationListener>
evaluationListeners
private JsonProvider
jsonProvider
private MappingProvider
mappingProvider
private java.util.Set<Option>
options
-
Constructor Summary
Constructors Modifier Constructor Description private
Configuration(JsonProvider jsonProvider, MappingProvider mappingProvider, java.util.EnumSet<Option> options, java.util.Collection<EvaluationListener> evaluationListeners)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Configuration
addEvaluationListeners(EvaluationListener... evaluationListener)
Creates a new Configuration by the provided evaluation listeners to the current listenersConfiguration
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 ConfigurationBuilderboolean
containsOption(Option option)
Check if this configuration contains the given optionstatic Configuration
defaultConfiguration()
Creates a new configuration based on default valuesprivate static Configuration.Defaults
getEffectiveDefaults()
java.util.Collection<EvaluationListener>
getEvaluationListeners()
Returns the evaluation listeners registered in this configurationjava.util.Set<Option>
getOptions()
Returns the options used by this configurationJsonProvider
jsonProvider()
ReturnsJsonProvider
used by this configurationConfiguration
jsonProvider(JsonProvider newJsonProvider)
Creates a new Configuration based on the givenJsonProvider
MappingProvider
mappingProvider()
ReturnsMappingProvider
used by this configurationConfiguration
mappingProvider(MappingProvider newMappingProvider)
Creates a new Configuration based on the givenMappingProvider
static void
setDefaults(Configuration.Defaults defaults)
Set Default configurationConfiguration
setEvaluationListeners(EvaluationListener... evaluationListener)
Creates a new Configuration with the provided evaluation listenersConfiguration
setOptions(Option... options)
Creates a new configuration with the provided options.
-
-
-
Field Detail
-
DEFAULTS
private static Configuration.Defaults DEFAULTS
-
jsonProvider
private final JsonProvider jsonProvider
-
mappingProvider
private final MappingProvider mappingProvider
-
options
private final java.util.Set<Option> options
-
evaluationListeners
private final java.util.Collection<EvaluationListener> evaluationListeners
-
-
Constructor Detail
-
Configuration
private Configuration(JsonProvider jsonProvider, MappingProvider mappingProvider, java.util.EnumSet<Option> options, java.util.Collection<EvaluationListener> evaluationListeners)
-
-
Method Detail
-
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 java.util.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 givenJsonProvider
- Parameters:
newJsonProvider
- json provider to use in new configuration- Returns:
- a new configuration
-
jsonProvider
public JsonProvider jsonProvider()
ReturnsJsonProvider
used by this configuration- Returns:
- jsonProvider used
-
mappingProvider
public Configuration mappingProvider(MappingProvider newMappingProvider)
Creates a new Configuration based on the givenMappingProvider
- Parameters:
newMappingProvider
- mapping provider to use in new configuration- Returns:
- a new configuration
-
mappingProvider
public MappingProvider mappingProvider()
ReturnsMappingProvider
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 java.util.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
-
-