org.odftoolkit.odfdom.dom

Enum OdfSchemaConstraint

java.lang.Object

java.lang.Enum<OdfSchemaConstraint>

org.odftoolkit.odfdom.dom.OdfSchemaConstraint

All Implemented Interfaces:

Serializable, Comparable<OdfSchemaConstraint>, ValidationConstraint

public enum OdfSchemaConstraint
extends Enum<OdfSchemaConstraint>
implements ValidationConstraint

This class is used for validation of the ODF Document. It contains the constraint messages are taken from the OASIS ODF 1.2 part 1, the XML Schema specification. These messages are used by the ValidationException for ODF validation. The validation is enabled, when an ErrorHandler was provided to the OdfPackage.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOCUMENT_WITHOUT_CONTENT_NOR_STYLES_XML At least \'content.xml' or 'styles.xml' have to be contained in the ODF XML Schema package.
DOCUMENT_WITHOUT_ODF_MIMETYPE A ODF mimetype is invalid for the ODF XML Schema document.
PACKAGE_SHALL_CONTAIN_MIMETYPE The 'mimetype' file have to be contained in the ODF XML Schema package.

Method Summary

Modifier and Type	Method and Description
String	getLocalizedMessage() Creates a localized description of a Constraint.
String	getMessage() Returns the detail message string of this Constraint.
static OdfSchemaConstraint	valueOf(String name) Returns the enum constant of this type with the specified name.
static OdfSchemaConstraint[]	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

DOCUMENT_WITHOUT_ODF_MIMETYPE

public static final OdfSchemaConstraint DOCUMENT_WITHOUT_ODF_MIMETYPE

A ODF mimetype is invalid for the ODF XML Schema document.

DOCUMENT_WITHOUT_CONTENT_NOR_STYLES_XML

public static final OdfSchemaConstraint DOCUMENT_WITHOUT_CONTENT_NOR_STYLES_XML

At least \'content.xml' or 'styles.xml' have to be contained in the ODF XML Schema package.

PACKAGE_SHALL_CONTAIN_MIMETYPE

public static final OdfSchemaConstraint PACKAGE_SHALL_CONTAIN_MIMETYPE

The 'mimetype' file have to be contained in the ODF XML Schema package.

Method Detail

values

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

Returns:

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

valueOf

public static OdfSchemaConstraint 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

getLocalizedMessage

public String getLocalizedMessage()

Creates a localized description of a Constraint. Subclasses may override this method in order to produce a locale-specific message. For subclasses that do not override this method, the default implementation returns the same result as getMessage().

Specified by:

getLocalizedMessage in interface ValidationConstraint

Returns:

The localized description of this constraint.

getMessage

public String getMessage()

Returns the detail message string of this Constraint.

Specified by:

getMessage in interface ValidationConstraint

Returns:

the detail message string of this Constraint instance (which may be null).