com.deltaxml.cores9api.config

Enum OrderlessPresentationMode

java.lang.Object

java.lang.Enum<OrderlessPresentationMode>

com.deltaxml.cores9api.config.OrderlessPresentationMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OrderlessPresentationMode>

public enum OrderlessPresentationMode
extends java.lang.Enum<OrderlessPresentationMode>

Specifies how the child elements of 'orderless' elements should be output.

When the value is OrderlessPresentationMode.A_MATCHES_DELETES_ADDS the output for any orderless comparison is presented in a defined order as follows:

1. all of the matches from the A input in the same order as they appear in A. In this context matches means elements with these deltaxml:deltaV2 values: 'A=B' and 'A!=B'.
2. These are followed by 'deletes' (elements which only appear in the 'A' input and have deltaxml:deltaV2='A')
3. Finally 'adds' (elements which only appear in the 'B' input and have deltaxml:deltaV2='B').

The 'adds' and then the 'deletes' appear in the same order as they appear in their respective inputs.

When the value is OrderlessPresentationMode.A_ADDS all of the elements from the A input appear in the result in the same order as they appear in that input. Their deltaxml:deltaV2 values ('A=B', 'A!=B' and 'A') will indicate if a similar (as defined by exact subtree or key matching) element appears in the B input and if so how they correspond. Finally the 'adds' - elements from B, with no matches to those in the A input, are listed in the order in which they appear in B.

When the value is OrderlessPresentationMode.B_MATCHES_ADDS_DELETES the output is presented as follows:

1. all of the matches from the B input in the same order as they appear in B. In this context matches means elements with these deltaxml:deltaV2 values: 'A=B' and 'A!=B'.
2. These are followed by 'adds' (elements which only appear in the 'B' input and have deltaxml:deltaV2='B')
3. Finally 'deletes' (elements which only appear in the 'A' input and have deltaxml:deltaV2='A').

The 'deletes' and then the 'adds' appear in the same order as they appear in their respective inputs.

When the value is OrderlessPresentationMode.B_DELETES all of the elements from the B input appear in the result in the same order as they appear in that input. Their deltaxml:deltaV2 values ('A=B', 'A!=B' and 'B') will indicate if a similar (as defined by exact subtree or key matching) element appears in the A input and if so how they correspond. Finally the 'deletes' - elements from A, with no matches to those in the B input, are listed in the order in which they appear in A.

The default value for this parameter setting is: OrderlessPresentationMode.B_DELETES

Enum Constant Summary

Enum Constants

Enum Constant and Description
A_ADDS Outputs elements from the A input, in order, followed by elements only in the B input, in order.
A_MATCHES_DELETES_ADDS Outputs elements from both inputs in their A order, followed by elements only in A and then elements only in B.
B_DELETES Outputs elements from the B input, in order, followed by elements only in the A input, in order.
B_MATCHES_ADDS_DELETES Outputs elements from both inputs in their B order, followed by elements only in B and then elements only in A.

Method Summary

Modifier and Type	Method and Description
static OrderlessPresentationMode	getOrderlessPresentationMode(java.lang.String value) Returns a OrderlessPresentationMode object from the supplied String value if appropriate.
java.lang.String	toString() Returns a String representation of OrderlessPresentationMode.
static OrderlessPresentationMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OrderlessPresentationMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

A_ADDS

public static final OrderlessPresentationMode A_ADDS

Outputs elements from the A input, in order, followed by elements only in the B input, in order.

A_MATCHES_DELETES_ADDS

public static final OrderlessPresentationMode A_MATCHES_DELETES_ADDS

Outputs elements from both inputs in their A order, followed by elements only in A and then elements only in B.

B_DELETES

public static final OrderlessPresentationMode B_DELETES

Outputs elements from the B input, in order, followed by elements only in the A input, in order.

B_MATCHES_ADDS_DELETES

public static final OrderlessPresentationMode B_MATCHES_ADDS_DELETES

Outputs elements from both inputs in their B order, followed by elements only in B and then elements only in A.

Method Detail

values

public static OrderlessPresentationMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OrderlessPresentationMode c : OrderlessPresentationMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OrderlessPresentationMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Returns a String representation of OrderlessPresentationMode.

Overrides:

toString in class java.lang.Enum<OrderlessPresentationMode>

Returns:

a String representing the OrderlessPresentationMode object

getOrderlessPresentationMode

public static OrderlessPresentationMode getOrderlessPresentationMode(java.lang.String value)

Returns a OrderlessPresentationMode object from the supplied String value if appropriate.

This method should not be used under normal circumstances, enum instance values should be used instead.

Parameters:

value - a String representation of a OrderlessPresentationMode value

Returns:

the OrderlessPresentationMode instance corresponding to the parameter, or null if the value is invalid