io.restassured.path.xml.config

Class XmlPathConfig

java.lang.Object

io.restassured.path.xml.config.XmlPathConfig

public class XmlPathConfig
extends Object

Allows you to configure how XmlPath will handle object mapping (de-serialization).

Constructor Summary

Constructors

Constructor and Description
XmlPathConfig() Creates a new XmlPathConfig that is configured to use the default JAXBObjectMapperFactory.
XmlPathConfig(String defaultCharset) Create a new XmlPathConfig that uses the defaultCharset when deserializing XML data.
XmlPathConfig(XmlPathConfig config) Create a new instance of a XmlPathConfig based on the properties in the supplied config.

Method Summary

Modifier and Type	Method and Description
XmlPathConfig	allowDocTypeDeclaration(boolean allowDocTypeDeclaration) Configure if XmlPath should provide support for DOCTYPE declarations (default is ).
XmlPathConfig	and() For syntactic sugar.
String	charset()
XmlPathConfig	charset(String charset)
XmlPathConfig	declaredNamespace(String prefix, String namespaceURI) Declares a namespace.
Map<String,String>	declaredNamespaces()
XmlPathConfig	declareNamespaces(Map<String,String> namespacesToDeclare) Specify declared namespaces that will be used when parsing XML.
XmlPathObjectDeserializer	defaultDeserializer()
XmlPathConfig	defaultObjectDeserializer(XmlPathObjectDeserializer defaultObjectDeserializer) Creates an json path configuration that uses the specified object de-serializer as default.
XmlParserType	defaultParserType()
XmlPathConfig	defaultParserType(XmlParserType defaultParserType) Creates an xml path configuration that uses the specified parser type as default.
XmlPathConfig	disableLoadingOfExternalDtd() Disables external DTD loading.
XmlPathConfig	feature(String uri, boolean enabled) Set a value of a feature flag.
Map<String,Boolean>	features()
XmlPathConfig	features(Map<String,Boolean> features) Specify features that will be used when parsing XML.
boolean	hasCustomJaxbObjectMapperFactory()
boolean	hasDeclaredNamespaces()
boolean	hasDefaultDeserializer()
boolean	hasDefaultParserType()
boolean	isAllowDocTypeDeclaration() Whether XmlPath should provide support for DOCTYPE declarations
boolean	isNamespaceAware() Whether XmlPath should provide support for XML namespaces
boolean	isValidating() Whether XmlPath should validate documents as they are parsed.
JAXBObjectMapperFactory	jaxbObjectMapperFactory()
XmlPathConfig	jaxbObjectMapperFactory(JAXBObjectMapperFactory jaxbObjectMapperFactory) Specify a custom Gson object mapper factory.
XmlPathConfig	namespaceAware(boolean namespaceAware) Configure if XmlPath should provide support for XML namespaces (default is ).
Map<String,Object>	properties()
XmlPathConfig	properties(Map<String,Object> properties) Specify properties that will be used when parsing XML.
XmlPathConfig	property(String name, Object value) Set a value of a property.
XmlPathConfig	validating(boolean isValidating) Configure if XmlPath should validate documents as they are parsed (default is ).
XmlPathConfig	with() For syntactic sugar.
static XmlPathConfig	xmlPathConfig()

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlPathConfig

public XmlPathConfig(XmlPathConfig config)

Create a new instance of a XmlPathConfig based on the properties in the supplied config.

Parameters:

config - The config to copy.

XmlPathConfig

public XmlPathConfig()

Creates a new XmlPathConfig that is configured to use the default JAXBObjectMapperFactory.

XmlPathConfig

public XmlPathConfig(String defaultCharset)

Create a new XmlPathConfig that uses the defaultCharset when deserializing XML data.

Method Detail

features

public Map<String,Boolean> features()

Returns:

A map containing features that will be used by the underlying XmlSlurper.

See Also:

XMLReader.setFeature(java.lang.String, boolean)

features

public XmlPathConfig features(Map<String,Boolean> features)

Specify features that will be used when parsing XML.

Parameters:

features - A map containing features that will be used by the underlying XmlSlurper.

Returns:

See Also:

XMLReader.setFeature(java.lang.String, boolean)

feature

public XmlPathConfig feature(String uri,
                             boolean enabled)

Set a value of a feature flag.

Parameters:

uri - The feature name, which is a fully-qualified URI.

enabled - The requested value of the feature (true or false).

Returns:

A new XmlPathConfig instance

See Also:

XMLReader.setFeature(java.lang.String, boolean)

validating

public XmlPathConfig validating(boolean isValidating)

Configure if XmlPath should validate documents as they are parsed (default is ). Note that this is only applicable when XmlPath.CompatibilityMode is equal to XmlPath.CompatibilityMode#XML.

Parameters:

isValidating - true if the parser should validate documents as they are parsed; false otherwise.

Returns:

A new XmlPathConfig instance

isValidating

public boolean isValidating()

Whether XmlPath should validate documents as they are parsed.

Returns:

a boolean indicating whether this is true or false

namespaceAware

public XmlPathConfig namespaceAware(boolean namespaceAware)

Configure if XmlPath should provide support for XML namespaces (default is ). Note that this is only applicable when XmlPath.CompatibilityMode is equal to XmlPath.CompatibilityMode#XML.

Parameters:

namespaceAware - true if the parser should provide support for XML namespaces; false otherwise.

Returns:

A new XmlPathConfig instance

isNamespaceAware

public boolean isNamespaceAware()

Whether XmlPath should provide support for XML namespaces

Returns:

a boolean indicating whether this is true or false

allowDocTypeDeclaration

public XmlPathConfig allowDocTypeDeclaration(boolean allowDocTypeDeclaration)

Configure if XmlPath should provide support for DOCTYPE declarations (default is ). Note that this is only applicable when XmlPath.CompatibilityMode is equal to XmlPath.CompatibilityMode#XML.

Parameters:

allowDocTypeDeclaration - true if the parser should provide support for DOCTYPE declarations; false otherwise.

Returns:

A new XmlPathConfig instance

isAllowDocTypeDeclaration

public boolean isAllowDocTypeDeclaration()

Whether XmlPath should provide support for DOCTYPE declarations

Returns:

a boolean indicating whether this is true or false

properties

public Map<String,Object> properties()

Returns:

A map containing properties that will be used by the underlying XmlSlurper.

See Also:

XMLReader.setProperty(String, Object)

properties

public XmlPathConfig properties(Map<String,Object> properties)

Specify properties that will be used when parsing XML.

Parameters:

properties - A map containing properties that will be used by the underlying XmlSlurper.

Returns:

A new XmlPathConfig instance

See Also:

XMLReader.setFeature(java.lang.String, boolean)

property

public XmlPathConfig property(String name,
                              Object value)

Set a value of a property.

Parameters:

name - The property name

value - The value of the property

Returns:

A new XmlPathConfig instance

See Also:

XMLReader.setFeature(java.lang.String, boolean)

disableLoadingOfExternalDtd

public XmlPathConfig disableLoadingOfExternalDtd()

Disables external DTD loading.

This is a shortcut for doing:

 setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);
 

Returns:

A new XmlPathConfig instance

See Also:

feature(String, boolean)

charset

public String charset()

Returns:

The charset to assume when parsing XML data

charset

public XmlPathConfig charset(String charset)

Returns:

A new XmlPathConfig instance with that assumes the supplied charset when parsing XML documents.

defaultParserType

public XmlParserType defaultParserType()

hasDefaultParserType

public boolean hasDefaultParserType()

hasCustomJaxbObjectMapperFactory

public boolean hasCustomJaxbObjectMapperFactory()

defaultDeserializer

public XmlPathObjectDeserializer defaultDeserializer()

hasDefaultDeserializer

public boolean hasDefaultDeserializer()

defaultParserType

public XmlPathConfig defaultParserType(XmlParserType defaultParserType)

Creates an xml path configuration that uses the specified parser type as default.

Parameters:

defaultParserType - The default parser type to use. If null then classpath scanning will be used.

defaultObjectDeserializer

public XmlPathConfig defaultObjectDeserializer(XmlPathObjectDeserializer defaultObjectDeserializer)

Creates an json path configuration that uses the specified object de-serializer as default.

Parameters:

defaultObjectDeserializer - The object de-serializer to use. If null then classpath scanning will be used.

jaxbObjectMapperFactory

public JAXBObjectMapperFactory jaxbObjectMapperFactory()

declaredNamespaces

public Map<String,String> declaredNamespaces()

Returns:

A map containing namespaces that will be used by the underlying XmlSlurper.

See Also:

XMLReader.setFeature(java.lang.String, boolean)

declareNamespaces

public XmlPathConfig declareNamespaces(Map<String,String> namespacesToDeclare)

Specify declared namespaces that will be used when parsing XML.

Parameters:

namespacesToDeclare - A map containing features that will be used by the underlying XmlSlurper.

Returns:

A new instance of XmlPathConfig

See Also:

XMLReader.setFeature(java.lang.String, boolean)

declaredNamespace

public XmlPathConfig declaredNamespace(String prefix,
                                       String namespaceURI)

Declares a namespace.

Parameters:

prefix - The feature name, which is a fully-qualified URI.

namespaceURI - The requested value of the feature (true or false).

Returns:

A new XmlPathConfig instance

See Also:

XMLReader.setFeature(java.lang.String, boolean)

jaxbObjectMapperFactory

public XmlPathConfig jaxbObjectMapperFactory(JAXBObjectMapperFactory jaxbObjectMapperFactory)

Specify a custom Gson object mapper factory.

Parameters:

jaxbObjectMapperFactory - The object mapper factory

hasDeclaredNamespaces

public boolean hasDeclaredNamespaces()

with

public XmlPathConfig with()

For syntactic sugar.

Returns:

The same XmlPathConfig instance

and

public XmlPathConfig and()

For syntactic sugar.

Returns:

The same XmlPathConfig instance

xmlPathConfig

public static XmlPathConfig xmlPathConfig()

Returns:

A static way to create a new XmlPathConfig instance without calling "new" explicitly. Mainly for syntactic sugar.