blob: 40127126989efc56a0a610a5b573dbf697247c0e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri Feb 22 10:26:22 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>OdfSchemaConstraint (ODFDOM API v0.8.9-incubating - http://incubator.apache.org/odftoolkit/)</title>
<meta name="date" content="2013-02-22">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OdfSchemaConstraint (ODFDOM API v0.8.9-incubating - http://incubator.apache.org/odftoolkit/)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OdfSchemaConstraint.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/odfdom/dom/OdfMetaDom.html" title="class in org.odftoolkit.odfdom.dom"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html" title="class in org.odftoolkit.odfdom.dom"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html" target="_top">Frames</a></li>
<li><a href="OdfSchemaConstraint.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum_constant_summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum_constant_detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.odftoolkit.odfdom.dom</div>
<h2 title="Enum OdfSchemaConstraint" class="title">Enum OdfSchemaConstraint</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a>&lt;<a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html" title="enum in org.odftoolkit.odfdom.dom">OdfSchemaConstraint</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.odfdom.dom.OdfSchemaConstraint</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html" title="enum in org.odftoolkit.odfdom.dom">OdfSchemaConstraint</a>&gt;, <a href="../../../../org/odftoolkit/odfdom/pkg/ValidationConstraint.html" title="interface in org.odftoolkit.odfdom.pkg">ValidationConstraint</a></dd>
</dl>
<hr>
<br>
<pre>public enum <span class="strong">OdfSchemaConstraint</span>
extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html" title="enum in org.odftoolkit.odfdom.dom">OdfSchemaConstraint</a>&gt;
implements <a href="../../../../org/odftoolkit/odfdom/pkg/ValidationConstraint.html" title="interface in org.odftoolkit.odfdom.pkg">ValidationConstraint</a></pre>
<div class="block">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 <code>ValidationException</code> for ODF validation.
The validation is enabled, when an <code>ErrorHandler</code> was provided to the <code>OdfPackage</code>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum_constant_summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Enum Constant and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html#DOCUMENT_WITHOUT_CONTENT_NOR_STYLES_XML">DOCUMENT_WITHOUT_CONTENT_NOR_STYLES_XML</a></strong></code>
<div class="block">At least \'content.xml' or 'styles.xml' have to be contained in the ODF XML Schema package.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html#DOCUMENT_WITHOUT_ODF_MIMETYPE">DOCUMENT_WITHOUT_ODF_MIMETYPE</a></strong></code>
<div class="block">A ODF mimetype is invalid for the ODF XML Schema document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html#PACKAGE_SHALL_CONTAIN_MIMETYPE">PACKAGE_SHALL_CONTAIN_MIMETYPE</a></strong></code>
<div class="block">The 'mimetype' file have to be contained in the ODF XML Schema package.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html#getLocalizedMessage()">getLocalizedMessage</a></strong>()</code>
<div class="block">Creates a localized description of a Constraint.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html#getMessage()">getMessage</a></strong>()</code>
<div class="block">Returns the detail message string of this Constraint.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html" title="enum in org.odftoolkit.odfdom.dom">OdfSchemaConstraint</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html#valueOf(java.lang.String)">valueOf</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html" title="enum in org.odftoolkit.odfdom.dom">OdfSchemaConstraint</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html#values()">values</a></strong>()</code>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class, java.lang.String)" title="class or interface in java.lang">valueOf</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum_constant_detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a name="DOCUMENT_WITHOUT_ODF_MIMETYPE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DOCUMENT_WITHOUT_ODF_MIMETYPE</h4>
<pre>public static final&nbsp;<a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html" title="enum in org.odftoolkit.odfdom.dom">OdfSchemaConstraint</a> DOCUMENT_WITHOUT_ODF_MIMETYPE</pre>
<div class="block">A ODF mimetype is invalid for the ODF XML Schema document.</div>
</li>
</ul>
<a name="DOCUMENT_WITHOUT_CONTENT_NOR_STYLES_XML">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DOCUMENT_WITHOUT_CONTENT_NOR_STYLES_XML</h4>
<pre>public static final&nbsp;<a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html" title="enum in org.odftoolkit.odfdom.dom">OdfSchemaConstraint</a> DOCUMENT_WITHOUT_CONTENT_NOR_STYLES_XML</pre>
<div class="block">At least \'content.xml' or 'styles.xml' have to be contained in the ODF XML Schema package.</div>
</li>
</ul>
<a name="PACKAGE_SHALL_CONTAIN_MIMETYPE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PACKAGE_SHALL_CONTAIN_MIMETYPE</h4>
<pre>public static final&nbsp;<a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html" title="enum in org.odftoolkit.odfdom.dom">OdfSchemaConstraint</a> PACKAGE_SHALL_CONTAIN_MIMETYPE</pre>
<div class="block">The 'mimetype' file have to be contained in the ODF XML Schema package.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="values()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html" title="enum in org.odftoolkit.odfdom.dom">OdfSchemaConstraint</a>[]&nbsp;values()</pre>
<div class="block">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:
<pre>
for (OdfSchemaConstraint c : OdfSchemaConstraint.values())
&nbsp; System.out.println(c);
</pre></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in
the order they are declared</dd></dl>
</li>
</ul>
<a name="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html" title="enum in org.odftoolkit.odfdom.dom">OdfSchemaConstraint</a>&nbsp;valueOf(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant
with the specified name</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd></dl>
</li>
</ul>
<a name="getLocalizedMessage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalizedMessage</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getLocalizedMessage()</pre>
<div class="block">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
<code>getMessage()</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/odfdom/pkg/ValidationConstraint.html#getLocalizedMessage()">getLocalizedMessage</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/odfdom/pkg/ValidationConstraint.html" title="interface in org.odftoolkit.odfdom.pkg">ValidationConstraint</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The localized description of this constraint.</dd></dl>
</li>
</ul>
<a name="getMessage()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMessage</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getMessage()</pre>
<div class="block">Returns the detail message string of this Constraint.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/odftoolkit/odfdom/pkg/ValidationConstraint.html#getMessage()">getMessage</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/odftoolkit/odfdom/pkg/ValidationConstraint.html" title="interface in org.odftoolkit.odfdom.pkg">ValidationConstraint</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the detail message string of this <tt>Constraint</tt> instance
(which may be <tt>null</tt>).</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OdfSchemaConstraint.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/odfdom/dom/OdfMetaDom.html" title="class in org.odftoolkit.odfdom.dom"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/odfdom/dom/OdfSchemaDocument.html" title="class in org.odftoolkit.odfdom.dom"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/odfdom/dom/OdfSchemaConstraint.html" target="_top">Frames</a></li>
<li><a href="OdfSchemaConstraint.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum_constant_summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum_constant_detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>