com.xmlmind.xml.xinclude

Enum XIncludeScheme.Option

java.lang.Object

java.lang.Enum<XIncludeScheme.Option>

com.xmlmind.xml.xinclude.XIncludeScheme.Option

All Implemented Interfaces:

Serializable, Comparable<XIncludeScheme.Option>

Enclosing class:

XIncludeScheme

public static enum XIncludeScheme.Option
extends Enum<XIncludeScheme.Option>

Option keys supported by the options argument of XIncludeScheme.createSimpleInclusion(com.xmlmind.xml.doc.Node, com.xmlmind.xml.doc.Node, boolean, java.lang.String, java.util.Map<java.lang.Object, java.lang.Object>, com.xmlmind.xml.load.SimpleInclusion[]).

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOW_ADVANCED_XPOINTER If true, allow the use of the XPointer xpointer() Scheme; otherwise only use the XPointer element() scheme; Boolean.TRUE or Boolean.FALSE.
SUPPORT_MULTIPLE_INSTANCES If true, it is expected that the including document will contain multiple instances of the inclusion returned by XIncludeScheme.createSimpleInclusion(com.xmlmind.xml.doc.Node, com.xmlmind.xml.doc.Node, boolean, java.lang.String, java.util.Map<java.lang.Object, java.lang.Object>, com.xmlmind.xml.load.SimpleInclusion[]).

Method Summary

Modifier and Type	Method and Description
static XIncludeScheme.Option	valueOf(String name) Returns the enum constant of this type with the specified name.
static XIncludeScheme.Option[]	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

ALLOW_ADVANCED_XPOINTER

public static final XIncludeScheme.Option ALLOW_ADVANCED_XPOINTER

If true, allow the use of the XPointer xpointer() Scheme; otherwise only use the XPointer element() scheme;

Boolean.TRUE or Boolean.FALSE. Default: Boolean.FALSE.

SUPPORT_MULTIPLE_INSTANCES

public static final XIncludeScheme.Option SUPPORT_MULTIPLE_INSTANCES

If true, it is expected that the including document will contain multiple instances of the inclusion returned by XIncludeScheme.createSimpleInclusion(com.xmlmind.xml.doc.Node, com.xmlmind.xml.doc.Node, boolean, java.lang.String, java.util.Map<java.lang.Object, java.lang.Object>, com.xmlmind.xml.load.SimpleInclusion[]).

Method Detail

values

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

Returns:

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

valueOf

public static XIncludeScheme.Option 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