X4OLanguageProperty (x4o 0.8.5-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<X4OLanguageProperty>
- - org.x4o.xml.core.config.X4OLanguageProperty

All Implemented Interfaces:

Serializable, Comparable<X4OLanguageProperty>
```
public enum X4OLanguageProperty
extends Enum<X4OLanguageProperty>
```
X4OLanguageProperty holds the language parser properties keys

Version:

1.0 6 Aug 2012

Author:

Willem Cazander

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CONFIG_ENTITY_RESOLVER` Resolve more entities from local sources.
`CONFIG_ERROR_HANDLER` Set for custom handling of validation errors.
`DEBUG_OUTPUT_ELD_PARSER` When set to true print also phases for parsing eld files.
`DEBUG_OUTPUT_HANDLER` When set to DefaultHandler2 xml debug events are fired to the object.
`DEBUG_OUTPUT_STREAM` When set to OutputStream xml debug is written to it.
`EL_BEAN_INSTANCE_MAP` The beans in this map are set into the EL context for reference.
`EL_FACTORY_INSTANCE` When set this instance is used in ElementLanguage.
`INPUT_BUFFER_SIZE` SAX parser input buffer size: 512-16k defaults to 8k.
`INPUT_EMPTY_NAMESPACE_URI` When set it allows parsing of non-namespace aware documents.
`INPUT_SOURCE_BASE_PATH` Sets the base path to resolve external input sources.
`INPUT_SOURCE_ENCODING` When set it overrides automatic encoding detection of sax parser.
`INPUT_SOURCE_OBJECT` When set use this InputSource instance for parsing.
`INPUT_SOURCE_STREAM` The input stream to parse, note is skipped when object is set.
`INPUT_SOURCE_SYSTEM_ID` Sets the system-id to the input source.
`LANGUAGE_NAME` Read-Only property returning the language we are working with.
`LANGUAGE_VERSION` Read-Only property returning the version of the language.
`PHASE_SKIP_RELEASE` When set to true skip the release phase.
`PHASE_SKIP_RUN` When set to true skip the run phase.
`PHASE_SKIP_SIBLINGS` When set to true skip the load siblings language phase.
`PHASE_STOP_AFTER` When set to an X4OPhase then parsing stops after completing the set phase.
`VALIDATION_ELD` When set to true then eld xml is validated.
`VALIDATION_ELD_XSD` When set to true than eld xsd xml grammer is also validated.
`VALIDATION_INPUT` When set to true then input xml is validated.
`VALIDATION_INPUT_XSD` When set to true then input xsd xml grammer is validated.
`VALIDATION_SCHEMA_PATH` When set this path is searched for xsd schema files in the language sub directory.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`getDefaultValue()` Returns the default value for this property.
`boolean`	`isValueValid(Object value)` Checks if the object is valid to set on this property.
`String`	`toUri()` Returns the uri defined by this property.
`static X4OLanguageProperty`	`valueByUri(String uri)` Search the enum for the value defined by the given uri.
`static X4OLanguageProperty`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static X4OLanguageProperty[]`	`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
  - LANGUAGE_NAME
```
public static final X4OLanguageProperty LANGUAGE_NAME
```
    Read-Only property returning the language we are working with.
  - LANGUAGE_VERSION
```
public static final X4OLanguageProperty LANGUAGE_VERSION
```
    Read-Only property returning the version of the language.
  - DEBUG_OUTPUT_STREAM
```
public static final X4OLanguageProperty DEBUG_OUTPUT_STREAM
```
    When set to OutputStream xml debug is written to it. note: when output-handler is set this property is ignored.
  - DEBUG_OUTPUT_HANDLER
```
public static final X4OLanguageProperty DEBUG_OUTPUT_HANDLER
```
    When set to DefaultHandler2 xml debug events are fired to the object.
  - DEBUG_OUTPUT_ELD_PARSER
```
public static final X4OLanguageProperty DEBUG_OUTPUT_ELD_PARSER
```
    When set to true print also phases for parsing eld files.
  - INPUT_BUFFER_SIZE
```
public static final X4OLanguageProperty INPUT_BUFFER_SIZE
```
    SAX parser input buffer size: 512-16k defaults to 8k.
  - INPUT_EMPTY_NAMESPACE_URI
```
public static final X4OLanguageProperty INPUT_EMPTY_NAMESPACE_URI
```
    When set it allows parsing of non-namespace aware documents.
  - INPUT_SOURCE_STREAM
```
public static final X4OLanguageProperty INPUT_SOURCE_STREAM
```
    The input stream to parse, note is skipped when object is set.
  - INPUT_SOURCE_ENCODING
```
public static final X4OLanguageProperty INPUT_SOURCE_ENCODING
```
    When set it overrides automatic encoding detection of sax parser.
  - INPUT_SOURCE_OBJECT
```
public static final X4OLanguageProperty INPUT_SOURCE_OBJECT
```
    When set use this InputSource instance for parsing.
  - INPUT_SOURCE_SYSTEM_ID
```
public static final X4OLanguageProperty INPUT_SOURCE_SYSTEM_ID
```
    Sets the system-id to the input source.
  - INPUT_SOURCE_BASE_PATH
```
public static final X4OLanguageProperty INPUT_SOURCE_BASE_PATH
```
    Sets the base path to resolve external input sources.
  - CONFIG_ERROR_HANDLER
```
public static final X4OLanguageProperty CONFIG_ERROR_HANDLER
```
    Set for custom handling of validation errors.
  - CONFIG_ENTITY_RESOLVER
```
public static final X4OLanguageProperty CONFIG_ENTITY_RESOLVER
```
    Resolve more entities from local sources.
  - EL_BEAN_INSTANCE_MAP
```
public static final X4OLanguageProperty EL_BEAN_INSTANCE_MAP
```
    The beans in this map are set into the EL context for reference.
  - EL_FACTORY_INSTANCE
```
public static final X4OLanguageProperty EL_FACTORY_INSTANCE
```
    When set this instance is used in ElementLanguage.
  - PHASE_STOP_AFTER
```
public static final X4OLanguageProperty PHASE_STOP_AFTER
```
    When set to an X4OPhase then parsing stops after completing the set phase.
  - PHASE_SKIP_RELEASE
```
public static final X4OLanguageProperty PHASE_SKIP_RELEASE
```
    When set to true skip the release phase.
  - PHASE_SKIP_RUN
```
public static final X4OLanguageProperty PHASE_SKIP_RUN
```
    When set to true skip the run phase.
  - PHASE_SKIP_SIBLINGS
```
public static final X4OLanguageProperty PHASE_SKIP_SIBLINGS
```
    When set to true skip the load siblings language phase.
  - VALIDATION_SCHEMA_PATH
```
public static final X4OLanguageProperty VALIDATION_SCHEMA_PATH
```
    When set this path is searched for xsd schema files in the language sub directory.
  - VALIDATION_INPUT
```
public static final X4OLanguageProperty VALIDATION_INPUT
```
    When set to true then input xml is validated.
  - VALIDATION_INPUT_XSD
```
public static final X4OLanguageProperty VALIDATION_INPUT_XSD
```
    When set to true then input xsd xml grammer is validated.
  - VALIDATION_ELD
```
public static final X4OLanguageProperty VALIDATION_ELD
```
    When set to true then eld xml is validated.
  - VALIDATION_ELD_XSD
```
public static final X4OLanguageProperty VALIDATION_ELD_XSD
```
    When set to true than eld xsd xml grammer is also validated.
- Method Detail
  - values
```
public static X4OLanguageProperty[] 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 (X4OLanguageProperty c : X4OLanguageProperty.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static X4OLanguageProperty 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
  - toUri
```
public String toUri()
```
    Returns the uri defined by this property.
    
    Returns:
    The uri defined by this property.
  - getDefaultValue
```
public Object getDefaultValue()
```
    Returns the default value for this property.
    
    Returns:
    The default value for this property.
  - isValueValid
```
public boolean isValueValid(Object value)
```
    Checks if the object is valid to set on this property. This is done by checking the allowed class types if they are assignable from the value class.
    
    Parameters:
    value - The object to check.
    
    Returns:
    Returns true when Object value is allowed to be set.
  - valueByUri
```
public static X4OLanguageProperty valueByUri(String uri)
```
    Search the enum for the value defined by the given uri.
    
    Parameters:
    uri - The uri to search for.
    
    Returns:
    Return the property for the given uri.
    
    Throws:
    
    IllegalArgumentException - when uri is not found.

Enum X4OLanguageProperty

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

LANGUAGE_NAME

LANGUAGE_VERSION

DEBUG_OUTPUT_STREAM

DEBUG_OUTPUT_HANDLER

DEBUG_OUTPUT_ELD_PARSER

INPUT_BUFFER_SIZE

INPUT_EMPTY_NAMESPACE_URI

INPUT_SOURCE_STREAM

INPUT_SOURCE_ENCODING

INPUT_SOURCE_OBJECT

INPUT_SOURCE_SYSTEM_ID

INPUT_SOURCE_BASE_PATH

CONFIG_ERROR_HANDLER

CONFIG_ENTITY_RESOLVER

EL_BEAN_INSTANCE_MAP

EL_FACTORY_INSTANCE

PHASE_STOP_AFTER

PHASE_SKIP_RELEASE

PHASE_SKIP_RUN

PHASE_SKIP_SIBLINGS

VALIDATION_SCHEMA_PATH

VALIDATION_INPUT

VALIDATION_INPUT_XSD

VALIDATION_ELD

VALIDATION_ELD_XSD

Method Detail

values

valueOf

toUri

getDefaultValue

isValueValid

valueByUri