Package com.deltaxml.docbook.config

Class Alignment

java.lang.Object

com.deltaxml.docbook.config.Alignment

public class Alignment
extends Object

Contains parameters that affect the alignment/matching of elements.

Constructor Summary

Constructors

Constructor	Description
Alignment()	Constructs a default Alignment object.
Alignment(KeyingMode keyingMode)	Constructs an Alignment object using the provided KeyingMode.

Method Summary

Modifier and Type	Method	Description
KeyingMode	getKeyingMode()	Gets the value of the keyingMode parameter.
void	setKeyingMode(KeyingMode value)	Sets the mode to use for adding keys to the input documents.

Methods inherited from class java.lang.Object

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

Constructor Details

Alignment

public Alignment()

Constructs a default Alignment object. Contains parameters that affect the alignment/matching of elements.

Alignment

public Alignment(KeyingMode keyingMode)

Constructs an Alignment object using the provided KeyingMode.

Parameters:

keyingMode - Which KeyingMode to use for alignment.

Method Details

getKeyingMode

public KeyingMode getKeyingMode()

Gets the value of the keyingMode parameter.

Returns:

the value of the keyingMode parameter

setKeyingMode

public void setKeyingMode(KeyingMode value)

Sets the mode to use for adding keys to the input documents.

Keys can be added to the input documents to force particular parts of the document to match up during a comparison. This method can be used to turn on keying and also gives an option of what to use as keys in the input document.

Default: KeyingMode.PRESERVE

Parameters:

value - the value to set for the keyingMode parameter

Throws:

IllegalArgumentException - if the value is null

See Also:

• KeyingMode