com.deltaxml.cores9api.config.ignoreChanges

Class Location

java.lang.Object

com.deltaxml.cores9api.config.ignoreChanges.Location

public class Location
extends java.lang.Object

This class is used to denote a location for which any changes should be ignored. A Location must be defined by an XPath. A ResultRule is then used to decide the behaviour of the result at this location. The default is BA.

Constructor Summary

Constructors

Constructor and Description
Location(java.lang.String ignoreXpath) Initialises a Location with only an XPath.
Location(java.lang.String ignoreXpath, ResultRule resultRule) Initialises a Location with both XPath and ResultRule.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIgnoreXpath() Gets the Location XPath.
ResultRule	getResultRule() Gets the ResultRule for the Location.
void	setIgnoreXpath(java.lang.String ignoreXpath) Sets the XPath used to mark the location of the node where changes should be ignored.
void	setResultRule(ResultRule resultRule) Sets the ResultRule for the Location.

Methods inherited from class java.lang.Object

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

Constructor Detail

Location

public Location(java.lang.String ignoreXpath,
                ResultRule resultRule)

Initialises a Location with both XPath and ResultRule.

Parameters:

ignoreXpath - the Location XPath.

resultRule - the ResultRule.

Throws:

java.lang.IllegalArgumentException - if passed resultRule is null or ignoreXpath is invalid.

Location

public Location(java.lang.String ignoreXpath)

Initialises a Location with only an XPath. The ResultRule of this Location will be set to the default rule.

Parameters:

ignoreXpath - the Location XPath.

Throws:

java.lang.IllegalArgumentException - if passed ignoreXpath is invalid.

Method Detail

getIgnoreXpath

public java.lang.String getIgnoreXpath()

Gets the Location XPath.

Returns:

Location XPath

setIgnoreXpath

public void setIgnoreXpath(java.lang.String ignoreXpath)

Sets the XPath used to mark the location of the node where changes should be ignored.

Parameters:

ignoreXpath - an XPath used to mark the location of the node where changes should be ignored.

Throws:

java.lang.IllegalArgumentException - if passed ignoreXpath is invalid.

getResultRule

public ResultRule getResultRule()

Gets the ResultRule for the Location.

Returns:

ResultRule for the Location.

setResultRule

public void setResultRule(ResultRule resultRule)

Sets the ResultRule for the Location.

Parameters:

resultRule - a ResultRule used to choose which value to show in the result.

Throws:

java.lang.IllegalArgumentException - if passed ResultRule is null.