org.atteo.xmlcombiner

Enum CombineSelf

java.lang.Object

java.lang.Enum<CombineSelf>

org.atteo.xmlcombiner.CombineSelf

All Implemented Interfaces:

Serializable, Comparable<CombineSelf>

public enum CombineSelf
extends Enum<CombineSelf>

Controls the behavior when merging two XML nodes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULTS Behaves exactly like MERGE if paired element exists in any subsequent dominant document.
MERGE Merge elements.
OVERRIDABLE Override element.
OVERRIDABLE_BY_TAG Override element.
OVERRIDE Override element.
REMOVE Remove entire element with attributes and children.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_NAME

Method Summary

Modifier and Type	Method and Description
static CombineSelf	valueOf(String name) Returns the enum constant of this type with the specified name.
static CombineSelf[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MERGE

public static final CombineSelf MERGE

Merge elements.

Attributes from dominant element override those from recessive element. Child elements are by default paired using their keys (tag name and selected attributes) and combined recursively. The exact behavior depends on 'combine.children' attribute value.

Example:
First:

 
  <config>
     <service id="1">
         <parameter>parameter</parameter>
     </service>
  </config>
 
 

Second:

 
  <config>
     <service id="1">
         <parameter2>parameter</parameter2>
     </service>
  </config>
 
 

Result:

 
  <config>
     <service id="1">
         <parameter>parameter</parameter>
         <parameter2>parameter</parameter2>
     </service>
  </config>
 
 

REMOVE

public static final CombineSelf REMOVE

Remove entire element with attributes and children.

Example:
First:

 
  <config>
     <service id="1">
         <parameter>parameter</parameter>
     </service>
  </config>
 
 

Second:

 
  <config>
     <service id="1" combine.self="REMOVE"/>
  </config>
 
 

Result:

 
  <config>
  </config>
 
 

DEFAULTS

public static final CombineSelf DEFAULTS

Behaves exactly like MERGE if paired element exists in any subsequent dominant document. If paired element is not found in any dominant document behaves the same as REMOVE

This behavior is specifically designed to allow specifying default values which are used only when given element exists in any subsequent document.

Example:
First:

 
  <config>
     <service id="1" combine.self="DEFAULTS">
         <parameter>parameter</parameter>
     </service>
     <service id="2" combine.self="DEFAULTS"/>
  </config>
 
 

Second:

 
 <config>
     <service id="1">
     </service>
  </config>
 
 

Result:

 
 <config>
     <service id="1">
         <parameter>parameter</parameter>
     </service>
  </config>
 
 

OVERRIDE

public static final CombineSelf OVERRIDE

Override element.

Completely ignores content from recessive document by overwriting it with element from dominant document.

Example:
First:

 
 <config>
     <service id="1">
         <parameter>parameter</parameter>
     </service>
  </config>
 
 

Second:

 
 <config>
     <service id="1" combine.self="override">
         <parameter2>parameter2</parameter2>
     </service>
  </config>
 
 

Result:

 
 <config>
     <service id="1">
         <parameter2>parameter2</parameter2>
     </service>
  </config>
 
 

OVERRIDABLE

public static final CombineSelf OVERRIDABLE

Override element.

Completely ignores content from recessive document by overwriting it with element from dominant document.

The difference with OVERRIDE is that OVERRIDABLE is specified on the tag in recessive document.

Example:
First:

 
  <config>
     <service id="id1" combine.self="OVERRIDABLE">
         <test/>
     </service>
  </config>
 
 

Second:

 
  <config>
  </config>
 
 

Result:

 
 <config>
     <service id="id1" combine.self="OVERRIDABLE">
         <test/>
     </service>
  </config>
 
 

Example2:
First:

 
  <config>
     <service id="id1" combine.self="OVERRIDABLE">
         <test/>
     </service>
  </config>
 
 

Second:

 
  <config>
 		<service id="id1"/>
  </config>
 
 

Result:

 
  <config>
 		<service id="id1"/>
  </config>
 
 

OVERRIDABLE_BY_TAG

public static final CombineSelf OVERRIDABLE_BY_TAG

Override element.

Completely ignores content from recessive document by overwriting it with element from dominant document.

The difference with OVERRIDABLE is that with OVERRIDABLE_BY_TAG recessive element is ignored even when the id is different.

Example:
First:

 
  <config>
     <service id="id1" combine.self="OVERRIDABLE_BY_TAG">
         <test/>
     </service>
  </config>
 
 

Second:

 
  <config>
 		<service id="id2"/>
  </config>
 
 

Result:

 
  <config>
 		<service id="id2"/>
  </config>
 
 

Field Detail

ATTRIBUTE_NAME

public static final String ATTRIBUTE_NAME

See Also:

Constant Field Values

Method Detail

values

public static CombineSelf[] 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 (CombineSelf c : CombineSelf.values())
    System.out.println(c);

Returns:

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

valueOf

public static CombineSelf valueOf(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:

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

NullPointerException - if the argument is null