You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ki...@apache.org on 2021/12/31 00:01:17 UTC
svn commit: r1896561 [2/8] - in /xmlbeans: site/src/documentation/content/xdocs/ trunk/ trunk/gradle/ trunk/samples/ trunk/samples/AbstractTypes/ trunk/samples/Any/ trunk/samples/Any/src/org/apache/xmlbeans/samples/any/ trunk/samples/DateTime/ trunk/sa...
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/SchemaParticle.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/SchemaParticle.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/SchemaParticle.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/SchemaParticle.java Fri Dec 31 00:01:16 2021
@@ -200,7 +200,7 @@ public interface SchemaParticle {
/**
* Returns user specified documentation
- *
+ * <pre>{@code
* <xs:element ... >
* <xs:annotation>
* <xs:documentation>
@@ -208,6 +208,7 @@ public interface SchemaParticle {
* </xs:documentation>
* </xs:annotation>
* </xs:element>
+ * }</pre>
*/
String getDocumentation();
}
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/SchemaType.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/SchemaType.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/SchemaType.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/SchemaType.java Fri Dec 31 00:01:16 2021
@@ -58,8 +58,8 @@ import javax.xml.namespace.QName;
* <li>There is another universal base type that is the base type
* for all simple types. This is the {@link XmlAnySimpleType#type},
* corresponding to xs:anySimpleType. Only XmlObject.type and
- * XmlAnySimpleType.type return <code>true</code> for {@link #isURType}, and
- * only XmlBeans.NO_TYPE returns <code>true</code> for {@link #isNoType}.
+ * XmlAnySimpleType.type return {@code true} for {@link #isURType}, and
+ * only XmlBeans.NO_TYPE returns {@code true} for {@link #isNoType}.
* <li>The two "special" kinds of types that are generated that
* do not formally exist in the actual Schema specification are
* document types and global attribute types (corresponding to
@@ -1082,12 +1082,14 @@ public interface SchemaType extends Sche
* Returns a QNameSet of elements that may exist in wildcard
* buchets and are not explicitly defined in this schema type.
* Note: In this example:
+ * <pre>{@code
* <xs:complexType name="exampleType">
* <xs:sequence>
* <xs:element name="someElement" type='xs:string' />
* <xs:any namespace="##targetNamespace" />
* </xs:sequence>
* </xs:complexType>
+ * }</pre>
* the returned QNameSet will not contain the qname of 'someElement'.
*
* @return the constructed QNameSet
@@ -1098,11 +1100,13 @@ public interface SchemaType extends Sche
* Returns a QNameSet of attributes that may exist in wildcard
* buchets and are not explicitly defined in this schema type.
* Note: In this example:
+ * <pre>{@code
* <xs:complexType name="exampleType">
* ...
* <xs:attribute name='someAttribute' type='xs:string' />
* <xs:anyAttribute namespace="##targetNamespace" />
* </xs:complexType>
+ * }</pre>
* the returned QNameSet will not contain the qname of 'someAttribute'.
*
* @return the constructed QNameSet
@@ -1111,7 +1115,7 @@ public interface SchemaType extends Sche
/**
* returns user specified documentation
- *
+ * <pre>{@code
* <xs:complexType ...>
* <xs:annotation>
* <xs:documentation>
@@ -1119,6 +1123,7 @@ public interface SchemaType extends Sche
* </xs:docmentation>
* </xs:annotation>
* </xs complexType>
+ * }</pre>
*/
String getDocumentation();
}
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/SchemaTypeSystem.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/SchemaTypeSystem.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/SchemaTypeSystem.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/SchemaTypeSystem.java Fri Dec 31 00:01:16 2021
@@ -39,10 +39,10 @@ import java.io.File;
* <p>
* For example, the following code compiles the schema in myXSDFile
* in the presence of only the minimal builtin type system.
- * The resulting SchemaTypeSystem <code>sts</code> contains only the definitions
+ * The resulting SchemaTypeSystem {@code sts} contains only the definitions
* from myXSD file. In order to load and validate an instance within
* the context of those types, we must next construct a
- * {@link SchemaTypeLoader} <code>stl</code> that contains both
+ * {@link SchemaTypeLoader} {@code stl} that contains both
* the builtin type system and the types defined within the myXSD file.
* <pre>
* SchemaTypeSystem sts = XmlBeans.compileXsd(new XmlObject[]
@@ -88,7 +88,7 @@ import java.io.File;
* <li> {@link #attributeTypes()} returns all the attribute types.
* </ul>
* </ol>
- *
+ *
* <p>
* A document type is a type that contains a single global element; there
* is one document type for each global element definition in a
@@ -111,7 +111,7 @@ import java.io.File;
* <p>The following code is a standard treewalk that visits every
* {@link SchemaType} in the SchemaTypeSystem once, including nested
* definitions.
- * <pre>
+ * <pre>{@code
* List allSeenTypes = new ArrayList();
* allSeenTypes.addAll(Arrays.asList(typeSystem.documentTypes()));
* allSeenTypes.addAll(Arrays.asList(typeSystem.attributeTypes()));
@@ -122,87 +122,87 @@ import java.io.File;
* System.out.println("Visiting " + sType.toString());
* allSeenTypes.addAll(Arrays.asList(sType.getAnonymousTypes()));
* }
- * </pre>
+ * }</pre>
*
- * @see SchemaType
- * @see SchemaTypeLoader
+ * @see SchemaType
+ * @see SchemaTypeLoader
* @see XmlBeans#compileXsd
* @see XmlBeans#typeLoaderUnion
* @see XmlBeans#getBuiltinTypeSystem
- */
+ */
public interface SchemaTypeSystem extends SchemaTypeLoader
{
/**
* Returns the name of this loader.
*/
- public String getName();
+ String getName();
/**
* Returns the global types defined in this loader.
*/
- public org.apache.xmlbeans.SchemaType[] globalTypes();
+ org.apache.xmlbeans.SchemaType[] globalTypes();
/**
* Returns the document types defined in this loader.
*/
- public org.apache.xmlbeans.SchemaType[] documentTypes();
+ org.apache.xmlbeans.SchemaType[] documentTypes();
/**
* Returns the attribute types defined in this loader.
*/
- public org.apache.xmlbeans.SchemaType[] attributeTypes();
+ org.apache.xmlbeans.SchemaType[] attributeTypes();
/**
* Returns the global elements defined in this loader.
*/
- public SchemaGlobalElement[] globalElements();
+ SchemaGlobalElement[] globalElements();
/**
* Returns the global attributes defined in this loader.
*/
- public SchemaGlobalAttribute[] globalAttributes();
+ SchemaGlobalAttribute[] globalAttributes();
/**
* Returns the model groups defined in this loader.
*/
- public SchemaModelGroup[] modelGroups();
+ SchemaModelGroup[] modelGroups();
/**
* Returns the attribute groups defined in this loader.
*/
- public SchemaAttributeGroup[] attributeGroups();
+ SchemaAttributeGroup[] attributeGroups();
/**
* Returns the top-level annotations */
- public SchemaAnnotation[] annotations();
+ SchemaAnnotation[] annotations();
/**
* Initializes a type system (resolves all handles within the type system).
*/
- public void resolve();
+ void resolve();
/**
* Locates a type, element, or attribute using the handle.
*/
- public SchemaComponent resolveHandle(String handle);
+ SchemaComponent resolveHandle(String handle);
/**
* Locates a type, element, or attribute using the handle.
*/
- public SchemaType typeForHandle(String handle);
+ SchemaType typeForHandle(String handle);
/**
* Returns the classloader used by this loader for resolving types.
*/
- public ClassLoader getClassLoader();
+ ClassLoader getClassLoader();
/**
* Saves this type system to a directory.
*/
- public void saveToDirectory(File classDir);
+ void saveToDirectory(File classDir);
/**
* Saves this type system using a Filer
*/
- public void save(Filer filer);
+ void save(Filer filer);
}
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlBase64Binary.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlBase64Binary.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlBase64Binary.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlBase64Binary.java Fri Dec 31 00:01:16 2021
@@ -65,14 +65,14 @@ public interface XmlBase64Binary extends
}
/**
- * Parses a {@link XmlBase64Binary} fragment from a String. For example: "<code><xml-fragment>VGhpcyBzdHJp</xml-fragment></code>".
+ * Parses a {@link XmlBase64Binary} fragment from a String. For example: "{@code <xml-fragment>VGhpcyBzdHJp</xml-fragment>}".
*/
public static XmlBase64Binary parse(java.lang.String s) throws org.apache.xmlbeans.XmlException {
return (XmlBase64Binary) XmlBeans.getContextTypeLoader().parse(s, type, null);
}
/**
- * Parses a {@link XmlBase64Binary} fragment from a String. For example: "<code><xml-fragment>VGhpcyBzdHJp</xml-fragment></code>".
+ * Parses a {@link XmlBase64Binary} fragment from a String. For example: "{@code <xml-fragment>VGhpcyBzdHJp</xml-fragment>}".
*/
public static XmlBase64Binary parse(java.lang.String s, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException {
return (XmlBase64Binary) XmlBeans.getContextTypeLoader().parse(s, type, options);
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlBeans.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlBeans.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlBeans.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlBeans.java Fri Dec 31 00:01:16 2021
@@ -369,7 +369,7 @@ public final class XmlBeans {
* A randomly generated name will be used if the name is null.</p>
*
* <p>The optional {@link BindingConfig} argument is used to control the shape
- * of the generated code. A <code>BindingConfig</code> isn't used if <code>Filer</code>
+ * of the generated code. A {@code BindingConfig} isn't used if {@code Filer}
* is null.</p>
*
* <p>The optional SchemaTypeLoader argument will be
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlCalendar.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlCalendar.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlCalendar.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlCalendar.java Fri Dec 31 00:01:16 2021
@@ -15,6 +15,8 @@
package org.apache.xmlbeans;
+import org.apache.xmlbeans.impl.util.SuppressForbidden;
+
import java.math.BigDecimal;
import java.util.Calendar;
import java.util.Date;
@@ -81,6 +83,13 @@ import java.util.TimeZone;
*/
public class XmlCalendar extends GregorianCalendar
{
+ private static int defaultYear = Integer.MIN_VALUE;
+ private static final int DEFAULT_DEFAULT_YEAR = 0;
+ private static final Date _beginningOfTime = new Date(Long.MIN_VALUE);
+
+
+
+
/**
* Constructs an XmlCalendar for a standard XML
* schema formatted date string.
@@ -137,6 +146,7 @@ public class XmlCalendar extends Gregori
this(GDate.timeZoneForGDate(date), date);
}
+ @SuppressForbidden("Locale is not known and we don't have a general class to set the default locale")
private XmlCalendar(TimeZone tz, GDateSpecification date)
{
super(tz);
@@ -244,15 +254,13 @@ public class XmlCalendar extends Gregori
/**
* Constructs an empty instance with no fields set.
*/
+ @SuppressForbidden("Locale is not known and we don't have a general class to set the default locale")
public XmlCalendar()
{
setGregorianChange(_beginningOfTime); // proleptic
clear();
}
- private static int defaultYear = Integer.MIN_VALUE;
- private static final int DEFAULT_DEFAULT_YEAR = 0;
-
/**
* Returns the default year that is used when no year is specified.
*/
@@ -304,8 +312,6 @@ public class XmlCalendar extends Gregori
}
}
- private static final Date _beginningOfTime = new Date(Long.MIN_VALUE);
-
/**
* Prints the XmlCalendar using a standard XML Schema
* format, as described in XmlCalendar(String s).
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlCursor.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlCursor.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlCursor.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlCursor.java Fri Dec 31 00:01:16 2021
@@ -26,7 +26,7 @@ import java.util.Map;
* <p>
* The tokens themselves are not exposed as objects, but their type and properties
* are discoverable through methods on the cursor. In particular, the general
- * category of token is represented by a {@link XmlCursor.TokenType TokenType}.<br/><br/>
+ * category of token is represented by a {@link XmlCursor.TokenType TokenType}.
* <p>
* You use an XmlCursor instance to navigate through and manipulate an XML
* instance document.
@@ -37,9 +37,9 @@ import java.util.Map;
* calling the {@link XmlTokenSource#newCursor() newCursor} method
* exposed by an object representing
* the XML, whether it was parsed into a strong type compiled from
- * schema or an {@link XmlObject XmlObject} (as in the no-schema case).<br/><br/>
+ * schema or an {@link XmlObject XmlObject} (as in the no-schema case).
* <p>
- * With an XmlCursor, you can also: <br/><br/>
+ * With an XmlCursor, you can also:
*
* <ul>
* <li>Execute XQuery and XPath expressions against the XML with the
@@ -60,7 +60,7 @@ import java.util.Map;
* its end, an attribute, comment, and so on. XmlCursor methods such as
* toNextToken, toNextSibling, toParent, and so on move the cursor
* among tokens. Each token's category is of a particular <em>type</em>, represented
- * by one of the nine types defined by the {@link XmlCursor.TokenType TokenType} class. <br/><br/>
+ * by one of the nine types defined by the {@link XmlCursor.TokenType TokenType} class.
* <p>
* When you get a new cursor for a whole instance document, the cursor is
* intially located before the STARTDOC token. This token, which has no analogy
@@ -71,11 +71,11 @@ import java.util.Map;
* located immediately before this token is at the very end of the document.
* It is not possible to position the cursor after the ENDDOC token.
* Thus, the STARTDOC and ENDDOC tokens are effectively "bookends" for the content of
- * the document.<br/><br/>
+ * the document.
* <p>
* For example, for the following XML, if you were the navigate a cursor
* through the XML document using toNextToken(), the list of token types that
- * follows represents the token sequence you would encounter. <br/><br/>
+ * follows represents the token sequence you would encounter.
*
* <pre>
* <sample x='y'>
@@ -83,21 +83,21 @@ import java.util.Map;
* </sample>
* </pre>
* <p>
- * STARTDOC <br/>
- * START (sample) <br/>
- * ATTR (x='y') <br/>
- * TEXT ("\n ") <br/>
- * START (value) <br/>
- * TEXT ("foo") <br/>
- * END (value) <br/>
- * TEXT ("\n") <br/>
- * END (sample)<br/>
- * ENDDOC <br/><br/>
+ * STARTDOC <br>
+ * START (sample) <br>
+ * ATTR (x='y') <br>
+ * TEXT ("\n ") <br>
+ * START (value) <br>
+ * TEXT ("foo") <br>
+ * END (value) <br>
+ * TEXT ("\n") <br>
+ * END (sample)<br>
+ * ENDDOC
* <p>
* When there are no more tokens available, hasNextToken() returns
* false and toNextToken() returns the special token type NONE and does not move
* the cursor.
- * <br/><br/>
+ *
* <p>
* The {@link #currentTokenType() currentTokenType()} method
* will return the type of the token that is immediately after the cursor.
@@ -106,16 +106,16 @@ import java.util.Map;
* isStartdoc(), isText(), isAttr(), and so on. Each returns a boolean
* value indicating whether the token that follows the cursor is the type
* in question.
- * <br/><br/>
+ *
* <p>
* A few other methods determine whether the token is of a kind that may include
* multiple token types. The isAnyAttr() method, for example, returns true if
* the token immediately following the cursor is any kind of attribute,
* including those of the ATTR token type and xmlns attributes.
- * <br/><br/>
+ *
* <p>
* Legitimate sequences of tokens for an XML document are described
- * by the following Backus-Naur Form (BNF): <br/>
+ * by the following Backus-Naur Form (BNF): <br>
*
* <pre>
* <doc> ::= STARTDOC <attributes> <content> ENDDOC
@@ -330,14 +330,14 @@ public interface XmlCursor extends XmlTo
* Deallocates resources needed to manage the cursor, rendering this cursor
* inoperable. Because cursors are managed by a mechanism which stores the
* XML, simply letting a cursor go out of scope and having the garbage collector
- * attempt to reclaim it may not produce desirable performance.<br/><br/>
+ * attempt to reclaim it may not produce desirable performance.
* <p>
* So, explicitly disposing a cursor allows the underlying implementation
- * to release its responsibility of maintaining its position.<br/><br/>
+ * to release its responsibility of maintaining its position.
* <p>
* After a cursor has been disposed, it may not be used again. It can
* throw IllegalStateException or NullPointerException if used after
- * disposal.<br/><br/>
+ * disposal.
*/
void dispose();
@@ -374,7 +374,7 @@ public interface XmlCursor extends XmlTo
* Executes the specified XPath expression against the XML that this
* cursor is in. The cursor's position does not change. To navigate to the
* selections, use {@link #hasNextSelection} and {@link #toNextSelection} (similar to
- * {@link java.util.Iterator}).<br/><br/>
+ * {@link java.util.Iterator}).
* <p>
* The root referred to by the expression should be given as
* a dot. The following is an example path expression:
@@ -393,7 +393,7 @@ public interface XmlCursor extends XmlTo
* Executes the specified XPath expression against the XML that this
* cursor is in. The cursor's position does not change. To navigate to the
* selections, use hasNextSelection and toNextSelection (similar to
- * java.util.Iterator).<br/><br/>
+ * java.util.Iterator).
* <p>
* The root referred to by the expression should be given as
* a dot. The following is an example path expression:
@@ -519,7 +519,7 @@ public interface XmlCursor extends XmlTo
* the URI is the namespace defined. For PROCINST, the local part
* is the target and the uri is "".
* <p>
- * In the following example, <code>xmlObject</code> represents
+ * In the following example, {@code xmlObject} represents
* an XML instance whose root element is not preceded by any other XML.
* This code prints the root element name (here, the local name, or
* name without URI).
@@ -552,7 +552,7 @@ public interface XmlCursor extends XmlTo
* then parents are queried. The prefix can be "" or null to indicate
* a search for the default namespace. To conform with the
* XML spec, the default namespace will return the no-namespace ("")
- * if it is not mapped.<br/><br/>
+ * if it is not mapped.
* <p>
* Note that this queries the current state of the document. When the
* document is persisted, the saving mechanism may synthesize namespaces
@@ -599,11 +599,11 @@ public interface XmlCursor extends XmlTo
/**
* Returns the strongly-typed XmlObject at the current START,
- * STARTDOC, or ATTR. <br/><br/>
+ * STARTDOC, or ATTR.
* <p>
* The strongly-typed object can be cast to the strongly-typed
* XBean interface corresponding to the XML Schema Type given
- * by result.getSchemaType().<br/><br/>
+ * by result.getSchemaType().
* <p>
* If a more specific type cannot be determined, an XmlObject
* whose schema type is anyType will be returned.
@@ -618,14 +618,14 @@ public interface XmlCursor extends XmlTo
* Returns the type of the current token. By definition, the current
* token is the token immediately to the right of the cursor.
* If you're in the middle of text, before a character, you get TEXT.
- * You can't dive into the text of an ATTR, COMMENT or PROCINST.<br/><br/>
+ * You can't dive into the text of an ATTR, COMMENT or PROCINST.
* <p>
* As an alternative, it may be more convenient for you to use one of the
* methods that test for a particular token type. These include the methods
* isStart(), isStartdoc(), isText(), isAttr(), and so on. Each returns a boolean
* value indicating whether the token that follows the cursor is the type
* in question.
- * <br/><br/>
+ *
*
* @return The TokenType instance for the token at the cursor's current
* location.
@@ -755,7 +755,7 @@ public interface XmlCursor extends XmlTo
/**
* Returns the type of the previous token. By definition, the previous
- * token is the token immediately to the left of the cursor.<br/><br/>
+ * token is the token immediately to the left of the cursor.
* <p>
* If you're in the middle of text, after a character, you get TEXT.
*
@@ -811,11 +811,11 @@ public interface XmlCursor extends XmlTo
/**
* Moves the cursor to the first token in the content of the current
* START or STARTDOC. That is, the first token after all ATTR and NAMESPACE
- * tokens associated with this START.<br/><br/>
+ * tokens associated with this START.
* <p>
* If the current token is not a START or STARTDOC, the cursor is not
* moved and NONE is returned. If the current START or STARTDOC
- * has no content, the cursor is moved to the END or ENDDOC token.<br/><br/>
+ * has no content, the cursor is moved to the END or ENDDOC token.
*
* @return The new current token type.
*/
@@ -825,7 +825,7 @@ public interface XmlCursor extends XmlTo
/**
* Moves the cursor to the END or ENDDOC token corresponding to the
- * current START or STARTDOC, and returns END or ENDDOC. <br/><br/>
+ * current START or STARTDOC, and returns END or ENDDOC.
* <p>
* If the current token is not a START or STARTDOC, the cursor is not
* moved and NONE is returned.
@@ -840,10 +840,10 @@ public interface XmlCursor extends XmlTo
* stops at the next non-TEXT token. Returns the number of characters
* actually moved across, which is guaranteed to be less than or equal to
* <em>maxCharacterCount</em>. If there is no further text, or if
- * there is no text at all, returns zero.<br/><br/>
+ * there is no text at all, returns zero.
* <p>
* Note this does not dive into attribute values, comment contents,
- * processing instruction contents, etc., but only content text.<br/><br/>
+ * processing instruction contents, etc., but only content text.
* <p>
* You can pass maxCharacterCount < 0 to move over all the text to the
* right. This has the same effect as toNextToken, but returns the amount
@@ -897,7 +897,7 @@ public interface XmlCursor extends XmlTo
/**
* Moves the cursor to the parent element or STARTDOC, or returns
- * false and does not move the cursor if there is no parent.<br/><br/>
+ * false and does not move the cursor if there is no parent.
* <p>
* Works if you're in attributes or content. Returns false only if at
* STARTDOC. Note that the parent of an END token is the corresponding
@@ -911,7 +911,7 @@ public interface XmlCursor extends XmlTo
/**
* Moves the cursor to the first child element, or returns false and
- * does not move the cursor if there are no element children. <br/><br/>
+ * does not move the cursor if there are no element children.
* <p>
* If the cursor is not currently in an element, it moves into the
* first child element of the next element.
@@ -1019,20 +1019,20 @@ public interface XmlCursor extends XmlTo
/**
* Moves the cursor to the first attribute of this element, or
* returns false and does not move the cursor if there are no
- * attributes. The order of attributes is arbitrary, but stable.<br/><br/>
+ * attributes. The order of attributes is arbitrary, but stable.
* <p>
* If the cursor is on a STARTDOC of a document-fragment, this method will
- * move it to the first top level attribute if one exists.<br></br>
+ * move it to the first top level attribute if one exists.
* <p>
* xmlns attributes (namespace declarations) are not considered
- * attributes by this function.<br/><br/>
+ * attributes by this function.
* <p>
* The cursor must be on a START or STARTDOC (in the case of a
* document fragment with top level attributes) for this method to
* succeed.
* <p>
* Example for looping through attributes:
- * <pre>
+ * <pre>{@code
* XmlCursor cursor = ... //cursor on START or STARTDOC
* if (cursor.toFirstAttribute())
* {
@@ -1044,7 +1044,7 @@ public interface XmlCursor extends XmlTo
* }
* while (cursor.toNextAttribute());
* }
- * </pre>
+ * }</pre>
*
* @return true if the cursor was moved; otherwise, false.
*/
@@ -1054,10 +1054,10 @@ public interface XmlCursor extends XmlTo
/**
* Moves the cursor to the last attribute of this element, or
* returns false and does not move the cursor if there are no
- * attributes. The order of attributes is arbitrary, but stable.<br/><br/>
+ * attributes. The order of attributes is arbitrary, but stable.
* <p>
* xmlns attributes (namespace declarations) are not considered
- * attributes by this function.<br/><br/>
+ * attributes by this function.
* <p>
* The cursor must be on a START or STARTDOC for this method
* to succeed.
@@ -1070,10 +1070,10 @@ public interface XmlCursor extends XmlTo
/**
* Moves the cursor to the next sibling attribute, or returns
* false and does not move the cursor if there is no next
- * sibling attribute. The order of attributes is arbitrary, but stable.<br/><br/>
+ * sibling attribute. The order of attributes is arbitrary, but stable.
* <p>
* xmlns attributes (namespace declarations) are not considered
- * attributes by this function.<br/><br/>
+ * attributes by this function.
* <p>
* The cursor must be on an attribute for this method to succeed.
*
@@ -1086,10 +1086,10 @@ public interface XmlCursor extends XmlTo
/**
* Moves the cursor to the previous sibling attribute, or returns
* false and does not move the cursor if there is no previous
- * sibling attribute. The order of attributes is arbitrary, but stable.<br/><br/>
+ * sibling attribute. The order of attributes is arbitrary, but stable.
* <p>
* xmlns attributes (namespace declarations) are not considered
- * attributes by this function.<br/><br/>
+ * attributes by this function.
* <p>
* The cursor must be on an attribute for this method to succeed.
*
@@ -1132,24 +1132,24 @@ public interface XmlCursor extends XmlTo
/**
* Gets the text value of the current document, element, attribute,
- * comment, procinst or text token. <br/><br/>
+ * comment, procinst or text token.
* <p>
* When getting the text value of an element, non-text content such
* as comments and processing instructions are ignored and text is concatenated.
* For elements that have nested element children, this
* returns the concatenated text of all mixed content and the
* text of all the element children, recursing in first-to-last
- * depthfirst order.<br/><br/>
+ * depthfirst order.
* <p>
- * For attributes, including namespaces, this returns the attribute value.<br/><br/>
+ * For attributes, including namespaces, this returns the attribute value.
* <p>
* For comments and processing instructions, this returns the text content
* of the comment or PI, not including the delimiting sequences <!-- -->, <? ?>.
* For a PI, the name of the PI is also not included.
- * <br/><br/>
- * The value of an empty tag is the empty string.<br/><br/>
+ *
+ * The value of an empty tag is the empty string.
* <p>
- * If the current token is END or ENDDOC, this throws an {@link java.lang.IllegalStateException}.<br/><br/>
+ * If the current token is END or ENDDOC, this throws an {@link java.lang.IllegalStateException}.
*
* @return The text value of the current token if the token's type is
* START, STARTDOC, TEXT, ATTR, COMMENT, PROCINST, or NAMESPACE; null
@@ -1162,24 +1162,24 @@ public interface XmlCursor extends XmlTo
* Copies the text value of the current document, element, attribute,
* comment, processing instruction or text token, counting right from
* this cursor's location up to <em>maxCharacterCount</em>,
- * and copies the returned text into <em>returnedChars</em>. <br/><br/>
+ * and copies the returned text into <em>returnedChars</em>.
* <p>
* When getting the text value of an element, non-text content such
* as comments and processing instructions are ignored and text is concatenated.
* For elements that have nested element children, this
* returns the concatenated text of all mixed content and the
* text of all the element children, recursing in first-to-last
- * depthfirst order.<br/><br/>
+ * depthfirst order.
* <p>
- * For attributes, including namespaces, this returns the attribute value.<br/><br/>
+ * For attributes, including namespaces, this returns the attribute value.
* <p>
* For comments and processing instructions, this returns the text contents
* of the comment or PI, not including the delimiting sequences <!-- -->, <? ?>. For
- * a PI, the text will not include the name of the PI.<br/><br/>
+ * a PI, the text will not include the name of the PI.
* <p>
- * If the current token is END or ENDDOC, this throws an {@link java.lang.IllegalStateException}.<br/><br/>
+ * If the current token is END or ENDDOC, this throws an {@link java.lang.IllegalStateException}.
* <p>
- * The value of an empty tag is the empty string.<br/><br/>
+ * The value of an empty tag is the empty string.
*
* @param returnedChars A character array to hold the returned characters.
* @param offset The position within returnedChars to which the first of the
@@ -1193,17 +1193,8 @@ public interface XmlCursor extends XmlTo
int getTextValue(char[] returnedChars, int offset, int maxCharacterCount);
/**
- * Returns the characters of the current TEXT token. If the current token
- * is not TEXT, returns "". If in the middle of a TEXT token, returns
- * those chars to the right of the cursor of the TEXT token.
- *
- * @return The requested text; an empty string if the current token type is
- * not TEXT.
- */
-
- /**
* Sets the text value of the XML at this cursor's location if that XML's
- * token type is START, STARTDOC, ATTR, COMMENT or PROCINST. <br/><br/>
+ * token type is START, STARTDOC, ATTR, COMMENT or PROCINST.
* <p>
* For elements that have nested children this first removes all
* the content of the element and replaces it with the given text.
@@ -1218,7 +1209,7 @@ public interface XmlCursor extends XmlTo
/**
* Sets the text value of the XML at this cursor's location (if that XML's
* token type is START, STARTDOC, ATTR, COMMENT or PROCINST) to the
- * contents of the specified character array. <br/><br/>
+ * contents of the specified character array.
* <p>
* For elements that have nested children this first removes all
* the content of the element and replaces it with the given text.
@@ -1288,11 +1279,11 @@ public interface XmlCursor extends XmlTo
/**
* Returns an integer indicating whether this cursor is before,
- * after, or at the same position as the specified cursor. <br/><br/>
+ * after, or at the same position as the specified cursor.
*
- * <code>a.comparePosition(b) < 0</code> means a is to the left of b.<br/>
- * <code>a.comparePosition(b) == 0</code> means a is at the same position as b.<br/>
- * <code>a.comparePosition(b) > 0</code> means a is to the right of b.<br/><br/>
+ * {@code a.comparePosition(b) < 0} means a is to the left of b.<br>
+ * {@code a.comparePosition(b) == 0} means a is at the same position as b.<br>
+ * {@code a.comparePosition(b) > 0} means a is to the right of b.
* <p>
* The sort order of cursors in the document is the token order.
* For example, if cursor "a" is at a START token and the cursor "b"
@@ -1314,7 +1305,7 @@ public interface XmlCursor extends XmlTo
/**
* Determines if this cursor is to the left of (or before)
* the specified cursor. Note that this is the same as
- * <code>a.comparePosition(b) < 0 </code>
+ * {@code a.comparePosition(b) < 0 }
*
* @param cursor The cursor whose position should be compared
* with this cursor.
@@ -1327,7 +1318,7 @@ public interface XmlCursor extends XmlTo
/**
* Determines if this cursor is at the same position as
* the specified cursor. Note that this is the same as
- * <code>a.comparePosition(b) == 0 </code>
+ * {@code a.comparePosition(b) == 0 }
*
* @param cursor The cursor whose position should be compared
* with this cursor.
@@ -1340,7 +1331,7 @@ public interface XmlCursor extends XmlTo
/**
* Determines if this cursor is to the right of (or after)
* the specified cursor. Note that this is the same as
- * <code>a.comparePosition(b) > 0 </code>
+ * {@code a.comparePosition(b) > 0 }
*
* @param cursor The cursor whose position should be compared
* with this cursor.
@@ -1352,10 +1343,10 @@ public interface XmlCursor extends XmlTo
/**
* Executes the specified XQuery expression against the XML this
- * cursor is in. <br/><br/>
+ * cursor is in.
* <p>
* The query may be a String or a compiled query. You can precompile
- * an XQuery expression using the XmlBeans.compileQuery method. <br/><br>
+ * an XQuery expression using the XmlBeans.compileQuery method.
* <p>
* The root referred to by the expression should be given as
* a dot. The following is an example path expression:
@@ -1372,7 +1363,7 @@ public interface XmlCursor extends XmlTo
/**
* Executes the specified XQuery expression against the XML this
- * cursor is in, and using the specified options. <br/><br/>
+ * cursor is in, and using the specified options.
*
* @param query The XQuery expression to execute.
* @param options Options for the query. For example, you can call
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlDocumentProperties.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlDocumentProperties.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlDocumentProperties.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlDocumentProperties.java Fri Dec 31 00:01:16 2021
@@ -38,43 +38,43 @@ public abstract class XmlDocumentPropert
* be any String.
* @param sourceName the name to set
* @see XmlOptions#setDocumentSourceName
- */
+ */
public void setSourceName ( String sourceName ) { put( SOURCE_NAME, sourceName ); }
/**
* Returns the name of the XML document file. Typically a URL, but may
* be any String.
* @see XmlOptions#setDocumentSourceName
- */
+ */
public String getSourceName ( ) { return (String) get( SOURCE_NAME ); }
-
+
/**
* Sets the encoding to use for the XML document. Should be a valid
* XML encoding string.
* @param encoding the ISO encoding name
* @see XmlOptions#setCharacterEncoding
- */
+ */
public void setEncoding ( String encoding ) { put( ENCODING, encoding ); }
/**
* Returns the encoding used for the XML document, as an ISO encoding name.
* @see XmlOptions#setCharacterEncoding
- */
+ */
public String getEncoding ( ) { return (String) get( ENCODING ); }
-
+
/**
- * Sets the XML version string to use in the <?xml?> declaration.
+ * Sets the XML version string to use in the {@code <xml>} declaration.
* (The XML specification is quite stable at "1.0".)
* @param version the XML version string
- */
+ */
public void setVersion ( String version ) { put( VERSION, version ); }
/**
- * Returns the XML version string used in the <?xml?> declaration.
- */
+ * Returns the XML version string used in the {@code <xml>} declaration.
+ */
public String getVersion ( ) { return (String) get( VERSION ); }
-
+
/**
* Sets the standalone property.
* @param standalone whether standalone is true or not
- */
+ */
public void setStandalone ( boolean standalone ) { put( STANDALONE, standalone ? "true" : null ); }
/**
* Returns the standalone property
@@ -85,49 +85,49 @@ public abstract class XmlDocumentPropert
}
/**
- * Sets the DOCTYPE name use in the <!DOCTYPE> declaration.
+ * Sets the DOCTYPE name use in the {@code <!DOCTYPE>} declaration.
* @param doctypename the doctypename
- */
+ */
public void setDoctypeName ( String doctypename ) { put( DOCTYPE_NAME, doctypename ); }
/**
- * Returns the DOCTYPE name used in the <!DOCTYPE> declaration.
- */
+ * Returns the DOCTYPE name used in the {@code <!DOCTYPE>} declaration.
+ */
public String getDoctypeName ( ) { return (String) get( DOCTYPE_NAME ); }
-
+
/**
- * Sets the DOCTYPE public ID to use in the <!DOCTYPE> declaration.
+ * Sets the DOCTYPE public ID to use in the {@code <!DOCTYPE>} declaration.
* @param publicid the public ID
- */
+ */
public void setDoctypePublicId ( String publicid ) { put( DOCTYPE_PUBLIC_ID, publicid ); }
/**
- * Returns the DOCTYPE public ID used in the <!DOCTYPE> declaration.
- */
+ * Returns the DOCTYPE public ID used in the {@code <!DOCTYPE>} declaration.
+ */
public String getDoctypePublicId ( ) { return (String) get( DOCTYPE_PUBLIC_ID ); }
-
+
/**
- * Sets the DOCTYPE system ID to use in the <!DOCTYPE> declaration.
+ * Sets the DOCTYPE system ID to use in the {@code <!DOCTYPE>} declaration.
* @param systemid the system ID
- */
+ */
public void setDoctypeSystemId ( String systemid ) { put( DOCTYPE_SYSTEM_ID, systemid ); }
/**
- * Returns the DOCTYPE system ID used in the <!DOCTYPE> declaration.
+ * Returns the DOCTYPE system ID used in the {@code <!DOCTYPE>} declaration.
*/
public String getDoctypeSystemId ( ) { return (String) get( DOCTYPE_SYSTEM_ID ); }
/**
* Sets the message digest used to summarize the document.
* @param digest the bytes of the digest
- *
+ *
* @see XmlOptions#setLoadMessageDigest
- */
+ */
public void setMessageDigest( byte[] digest ) { put( MESSAGE_DIGEST, digest ); }
/**
* Returns the message digest used to summarize the document.
- *
+ *
* @see XmlOptions#setLoadMessageDigest
- */
+ */
public byte[] getMessageDigest( ) { return (byte[]) get( MESSAGE_DIGEST ); }
-
+
/**
* Used to store the original name (a String) for
* the source from which the XML document was loaded.
@@ -138,37 +138,37 @@ public abstract class XmlDocumentPropert
* both automatically set this value to the filename.
*/
public static final Object SOURCE_NAME = new Object();
-
+
/**
* Document encoding
*/
public static final Object ENCODING = new Object();
-
+
/**
* Document version
*/
public static final Object VERSION = new Object();
-
+
/**
* Document standlone
*/
public static final Object STANDALONE = new Object();
-
+
/**
* Doc type name
*/
public static final Object DOCTYPE_NAME = new Object();
-
+
/**
* Doc type public id
*/
public static final Object DOCTYPE_PUBLIC_ID = new Object();
-
+
/**
* Doc type system id
*/
public static final Object DOCTYPE_SYSTEM_ID = new Object();
-
+
/**
* SHA message digest
*/
@@ -182,7 +182,7 @@ public abstract class XmlDocumentPropert
* @param value The value to attach to the document.
*/
public abstract Object put ( Object key, Object value );
-
+
/**
* Returns a value previously attached to a document using set.
*
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlErrorCodes.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlErrorCodes.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlErrorCodes.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlErrorCodes.java Fri Dec 31 00:01:16 2021
@@ -976,7 +976,7 @@ public abstract class XmlErrorCodes
public static final String ATTR_NOTATION_TYPE_FORBIDDEN = "enumeration-required-notation-attr";
/**
- * <a href="http://www.w3c.org/TR/xmlschema-2/#NOTATION">XMLSchema Datatypes 1.0: Definition of type NOTATION</>
+ * <a href="http://www.w3c.org/TR/xmlschema-2/#NOTATION">XMLSchema Datatypes 1.0: Definition of type NOTATION</a>
*/
public static final String ATTR_COMPATIBILITY_TARGETNS = "notation-targetns-attr";
@@ -1149,12 +1149,12 @@ public abstract class XmlErrorCodes
public static final String ELEM_DEFAULT_VALID$MIXED_AND_EMPTIABLE = "cos-valid-default.2.2.2";
/**
- * <a href="http://www.w3c.org/TR/xmlschema-2/#ID">XMLSchema Datatypes 1.0: Definitions of types ID, IDREF, IDREFS, ENTITY, ENTITIES, NOTATION</>
+ * <a href="http://www.w3c.org/TR/xmlschema-2/#ID">XMLSchema Datatypes 1.0: Definitions of types ID, IDREF, IDREFS, ENTITY, ENTITIES, NOTATION</a>
*/
public static final String ELEM_COMPATIBILITY_TYPE = "id-idref-idrefs-entity-entities-notation";
/**
- * <a href="http://www.w3c.org/TR/xmlschema-2/#NOTATION">XMLSchema Datatypes 1.0: Definition of type NOTATION</>
+ * <a href="http://www.w3c.org/TR/xmlschema-2/#NOTATION">XMLSchema Datatypes 1.0: Definition of type NOTATION</a>
*/
public static final String ELEM_COMPATIBILITY_TARGETNS = "notation-targetns-elem";
@@ -1845,7 +1845,7 @@ public abstract class XmlErrorCodes
* <blockquote>
* <b>NOTE: </b>
* The <i>only</i> substantive function of the value <i>prohibited</i> for the
- * <code>use</code> attribute of an <a href="http://www.w3c.org/TR/xmlschema-1/#element-attribute" class="eltref"><attribute></a> is in establishing
+ * {@code use} attribute of an <a href="http://www.w3c.org/TR/xmlschema-1/#element-attribute" class="eltref"><attribute></a> is in establishing
* the correspondence between a complex type defined by restriction and its XML
* representation. It serves to prevent inheritance of an identically named attribute
* use from the <a href="http://www.w3c.org/TR/xmlschema-1/#ct-base_type_definition" class="propref">{base type definition}</a>.
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlException.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlException.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlException.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlException.java Fri Dec 31 00:01:16 2021
@@ -15,41 +15,41 @@
package org.apache.xmlbeans;
-import java.util.List;
-import java.util.Collections;
-import java.util.Collection;
import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
/**
* A checked exception that can be thrown while processing,
* parsing, or compiling XML. May contain any number of {@link XmlError}
* objects.
- * <p>
+ *
* @see XmlError
* @see XmlRuntimeException
*/
public class XmlException extends Exception
{
private static final long serialVersionUID = 1L;
-
+
/**
* Constructs an XmlException from a message.
- */
+ */
public XmlException ( String m ) { super( m ); }
-
+
/**
* Constructs an XmlException from a message and a cause.
- */
+ */
public XmlException ( String m, Throwable t ) { super( m, t ); }
-
+
/**
* Constructs an XmlException from a cause.
- */
+ */
public XmlException ( Throwable t ) { super( t ); }
-
+
/**
* Constructs an XmlException from an {@link XmlError}.
- */
+ */
public XmlException ( XmlError error )
{
this( error.toString(), null, error );
@@ -57,15 +57,15 @@ public class XmlException extends Except
/**
* Constructs an XmlException from a message, a cause, and an {@link XmlError}.
- */
+ */
public XmlException ( String m, Throwable t, XmlError error )
{
this( m, t, Collections.singletonList( error ) );
}
-
+
/**
* Constructs an XmlException from a message, a cause, and a collection of {@link XmlError XmlErrors}.
- */
+ */
public XmlException ( String m, Throwable t, Collection errors )
{
super( m, t );
@@ -76,7 +76,7 @@ public class XmlException extends Except
/**
* Constructs an XmlException from an {@link XmlRuntimeException}.
- */
+ */
public XmlException ( XmlRuntimeException xmlRuntimeException )
{
super(
@@ -87,10 +87,10 @@ public class XmlException extends Except
if (errors != null)
_errors = Collections.unmodifiableList( new ArrayList( errors ) );
}
-
+
/**
* Returns the first {@link XmlError XmlErrors} that caused the exception, if any.
- */
+ */
public XmlError getError ( )
{
if (_errors == null || _errors.size() == 0)
@@ -98,10 +98,10 @@ public class XmlException extends Except
return (XmlError) _errors.get( 0 );
}
-
+
/**
* Returns the collection of {@link XmlError XmlErrors} that caused the exception, if any.
- */
+ */
public Collection getErrors ( )
{
return _errors;
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlLineNumber.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlLineNumber.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlLineNumber.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlLineNumber.java Fri Dec 31 00:01:16 2021
@@ -22,52 +22,52 @@ import org.apache.xmlbeans.XmlCursor.Xml
* If a document is parsed with line numbers
* enabled, these bookmarks will be placed at appropriate locations
* within the document.
- *
- * @see XmlOptions#setLoadLineNumbers
+ *
+ * @see XmlOptions#setLoadLineNumbers
*/
public class XmlLineNumber extends XmlBookmark
{
/**
* Constructs a line number with no column or offset information.
* @param line the line number - the first line is 1
- */
+ */
public XmlLineNumber ( int line ) { this( line, -1, -1 ); }
-
+
/**
* Constructs a line number and column with no file offset information.
* @param line the line number - the first line is 1
- * @param line the column number - the first column is 1
+ * @param column the column number - the first column is 1
*/
public XmlLineNumber ( int line, int column ) { this( line, column, -1 ); }
-
+
/**
* Constructs a line number and column with no file offset information.
* @param line the line number - the first line is 1
- * @param line the column number - the first column is 1
- * @param line the file character offset - the first character in the file is 0
+ * @param column the column number - the first column is 1
+ * @param offset the file character offset - the first character in the file is 0
*/
public XmlLineNumber ( int line, int column, int offset )
{
super( false );
-
+
_line = line;
_column = column;
_offset = offset;
}
-
+
/**
* Returns the 1-based line number, or -1 if not known.
- */
+ */
public int getLine ( ) { return _line; }
-
+
/**
* Returns the 1-based column number, or -1 if not known.
- */
+ */
public int getColumn ( ) { return _column; }
-
+
/**
* Returns the 0-based file offset number, or -1 if not known.
- */
+ */
public int getOffset ( ) { return _offset; }
private int _line, _column, _offset;
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlObject.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlObject.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlObject.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlObject.java Fri Dec 31 00:01:16 2021
@@ -32,7 +32,6 @@ import javax.xml.namespace.QName;
* <p>
* On this base class you will find a number of common facilities that
* all XML Bean classes provide:
- * <p>
* <ul>
* <li>Every XML Bean class has an inner Factory class for creating and parsing
* instances, including XmlObject. Use {@link XmlObjectFactory} itself
@@ -191,30 +190,27 @@ public interface XmlObject extends XmlTo
/**
* Selects a path. Path can be a string or precompiled path String.
* <p>
- * <p>
* The path must be a relative path, where "." represents the
* element or attribute containing this XmlObject, and it must select
* only other elements or attributes. If a non-element or non-attribute
* is selected, an unchecked exception is thrown.
* <p>
- * <p>
* The array that is returned contains all the selected
* XmlObjects, within the same document, listed in document
* order. The actual array type of the result is inferred
* from the closest common base type of selected results.
* <p>
- * <p>
* Here is an example of usage. Suppose we have a global
* element definition for "owner" whose type is "person":
*
- * <pre>
- * <schema targetNamespace="http://openuri.org/sample">
- * <element name="owner" type="person"/>
- * <complexType name="person">
+ * <pre>{@code
+ * <schema targetNamespace="http://openuri.org/sample">
+ * <element name="owner" type="person"/>
+ * <complexType name="person">
* [...]
- * </complexType>
- * </schema>
- * </pre>
+ * </complexType>
+ * </schema>
+ * }</pre>
* <p>
* and suppose "owner" tags can be scattered throughout the
* document. Then we can write the following code to find
@@ -275,6 +271,7 @@ public interface XmlObject extends XmlTo
* Use the <em>options</em> parameter to specify the following:</p>
*
* <table>
+ * <caption>Method overview</caption>
* <tr><th>To specify this</th><th>Use this method</th></tr>
* <tr>
* <td>The document type for the root element.</td>
@@ -330,7 +327,7 @@ public interface XmlObject extends XmlTo
* new type.
* <p>
* Returns the new XmlObject if the type change was successful,
- * the old XmlObject if no changes could be made. <p/>
+ * the old XmlObject if no changes could be made. <p>
* Certain type changes may be prohibited in the interior of an xml
* tree due to schema type system constraints (that is, due
* to a parent container within which the newly specified
@@ -357,12 +354,12 @@ public interface XmlObject extends XmlTo
* new type and container name is the new name.
* <p>
* Returns the new XmlObject if the substitution was successful,
- * the old XmlObject if no changes could be made. <p/>
+ * the old XmlObject if no changes could be made. <p>
* In order for the operation to succeed, several conditions must hold:
* <ul><li> the container of this type must be an element </li>
- * <li> a global element with the name <code>newName</code> must exist
+ * <li> a global element with the name {@code newName} must exist
* and must be in the substitution group of the containing element </li>
- * <li> the <code>newType</code> type must be consistent with the declared
+ * <li> the {@code newType} type must be consistent with the declared
* type of the new element </li></ul>
* <p>
* If the type change is allowed, then the new XmlObject should
@@ -403,7 +400,7 @@ public interface XmlObject extends XmlTo
* Note that when producing XML any object other than very root of the
* document, then you are guaranteed to be looking at only a fragment
* of XML, i.e., just the contents of an element or attribute, and
- * and we will produce a string that starts with an <code><xml-fragment></code> tag.
+ * and we will produce a string that starts with an {@code <xml-fragment>} tag.
* The XmlOptions.setSaveOuter() option on xmlText can be used to produce
* the actual element name above the object if you wish.
*
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlOptionCharEscapeMap.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlOptionCharEscapeMap.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlOptionCharEscapeMap.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlOptionCharEscapeMap.java Fri Dec 31 00:01:16 2021
@@ -26,9 +26,8 @@ import java.util.Map;
* latter option applies only to the 5 characters defined as predefined entities
* in the XML Spec).
* <p>
- * <ul>
* For example:
- * <pre>
+ * <pre>{@code
* XmlOptionCharEscapeMap escapes = new XmlOptionCharEscapeMap();
* escapes.addMapping('A', XmlOptionCharEscapeMap.HEXADECIMAL);
* escapes.addMapping('B', XmlOptionCharEscapeMap.DECIMAL);
@@ -43,7 +42,7 @@ import java.util.Map;
* B being printed as B
* > being printed as >
*
- * </pre>
+ * }</pre>
*/
public class XmlOptionCharEscapeMap {
public static final int PREDEF_ENTITY = 0;
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlOptions.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlOptions.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlOptions.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlOptions.java Fri Dec 31 00:01:16 2021
@@ -28,55 +28,56 @@ import java.util.*;
* <p>
* There are two styles for using XmlOptions: multiline setup, and single-line use.
* Here are two examples. First, multiline style:
- * <pre>
+ * <pre>{@code
* XmlOptions opts = new XmlOptions();
* opts.setSavePrettyPrint();
* opts.setSavePrettyPrintIndent(4);
* System.out.println(xobj.xmlText(opts));
- * </pre>
+ * }</pre>
* <p>
* The alternative is single-line usage:
- * <pre>
+ * <pre>{@code
* System.out.println(xobj.xmlText(
* new XmlOptions().setSavePrettyPrint().setSavePrettyPrintIndent(4)));
- * </pre>
+ * }</pre>
* <p>
* Table showing where each option gets used.
* Note that:
* <ul>
- * <li>options available for <code>newInstance</code> methods will also
- * apply for <code>parse</code> methods</li>
- * <li>options used for <code>validate</code> methods are also used for
- * <code>compile</code> methods, since compilation usually implies
+ * <li>options available for {@code newInstance} methods will also
+ * apply for {@code parse} methods</li>
+ * <li>options used for {@code validate} methods are also used for
+ * {@code compile} methods, since compilation usually implies
* validation against Schema for Schemas</li>
* </ul>
*
* <table border="1">
+ * <caption>Option matrix</caption>
* <tr>
- * <th align="center"><code>newInstance</code> methods</th>
- * <th align="center"><code>parse</code> methods</th>
- * <th align="center"><code>validate</code> methods</th>
- * <th align="center"><code>compile</code> methods</th>
- * <th align="center"><code>save</code> and <code>xmlText</code>methods</th>
+ * <th>{@code newInstance} methods</th>
+ * <th>{@code parse} methods</th>
+ * <th>{@code validate} methods</th>
+ * <th>{@code compile} methods</th>
+ * <th>{@code save} and {@code xmlText}methods</th>
* </tr>
* <tr>
- * <td align="center"><code>setDocumentType</code><br/>
- * <code>setDocumentSourceName</code><br/>
- * <code>setValidateOnSet</code><br/>
- * <code>setUnsynchronized</code></td>
- * <td align="center"><code>setLoad***</code><br/>
- * <code>setEntityResolver</code></td>
- * <td align="center"><code>setErrorListener</code><br/>
- * <code>setValidateTreatLaxAsSkip</code>
- * <code>setValidateStrict</code></td>
- * <td align="center"><code>setErrorListener</code><br/>
- * <code>setCompile***</code><br/>
- * <code>setEntityResolver</code><br/>
- * <code>setBaseURI</code><br/>
- * <code>setGenerateJavaVersion</code></td>
- * <td align="center"><code>setSave***</code><br/>
- * <code>setUseDefaultNamespace</code><br/>
- * <code>setCharacterEncoding</code></td>
+ * <td>{@code setDocumentType}<br>
+ * {@code setDocumentSourceName}<br>
+ * {@code setValidateOnSet}<br>
+ * {@code setUnsynchronized}</td>
+ * <td>{@code setLoad***}<br>
+ * {@code setEntityResolver}</td>
+ * <td>{@code setErrorListener}<br>
+ * {@code setValidateTreatLaxAsSkip}
+ * {@code setValidateStrict}</td>
+ * <td>{@code setErrorListener}<br>
+ * {@code setCompile***}<br>
+ * {@code setEntityResolver}<br>
+ * {@code setBaseURI}<br>
+ * {@code setGenerateJavaVersion}</td>
+ * <td>{@code setSave***}<br>
+ * {@code setUseDefaultNamespace}<br>
+ * {@code setCharacterEncoding}</td>
* </tr>
* </table>
*/
@@ -232,7 +233,7 @@ public class XmlOptions implements java.
/**
- * When used with <code>setSavePrettyPrint</code> this sets the indent
+ * When used with {@code setSavePrettyPrint} this sets the indent
* amount to use.
*
* @param indent the indent amount to use
@@ -249,7 +250,7 @@ public class XmlOptions implements java.
}
/**
- * When used with <code>setSavePrettyPrint</code> this sets the offset
+ * When used with {@code setSavePrettyPrint} this sets the offset
* amount to use.
*
* @param offset the offset amount to use
@@ -270,7 +271,7 @@ public class XmlOptions implements java.
* encoding to use.
*
* @param encoding the character encoding
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
* @see XmlTokenSource#save(java.io.File, XmlOptions)
*/
public XmlOptions setCharacterEncoding(String encoding) {
@@ -284,10 +285,10 @@ public class XmlOptions implements java.
/**
* When parsing a document, this sets the type of the root
* element. If this is set, the parser will not try to guess
- * the type based on the document's <code>QName</code>.
+ * the type based on the document's {@code QName}.
*
* @param type The root element's document type.
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
*/
public XmlOptions setDocumentType(SchemaType type) {
return set(XmlOptionsKeys.DOCUMENT_TYPE, type);
@@ -308,7 +309,7 @@ public class XmlOptions implements java.
* <p>The following simple example illustrates using an error listener
* during validation.</p>
*
- * <pre>
+ * <pre>{@code
* // Create an XmlOptions instance and set the error listener.
* XmlOptions validateOptions = new XmlOptions();
* ArrayList errorList = new ArrayList();
@@ -331,12 +332,12 @@ public class XmlOptions implements java.
* error.getCursorLocation().xmlText() + "\n");
* }
* }
- * </pre>
+ * }</pre>
*
* @param c A collection that will be filled with {@link XmlError} objects
* via {@link Collection#add}
* @see XmlError
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
* @see XmlObject#validate(XmlOptions)
* @see XmlBeans#compileXsd
* @see XmlOptions#setLoadLineNumbers
@@ -540,7 +541,7 @@ public class XmlOptions implements java.
/**
* This option controls whether saving saves out the XML
- * declaration (<?xml ... ?>
+ * declaration {@code <?xml ... ?>}
*
* @see XmlTokenSource#save(java.io.File, XmlOptions)
* @see XmlTokenSource#xmlText(XmlOptions)
@@ -561,11 +562,12 @@ public class XmlOptions implements java.
/**
* This option controls when saving will use CDATA blocks.
* CDATA will be used if the folowing condition is true:
- * <br/>textLength > cdataLengthThreshold && entityCount > cdataEntityCountThreshold
- * <br/>The default value of cdataLengthThreshold is 32.
- * <br/>
- * <br/>Use the folowing values for these cases:
+ * <br>{@code textLength > cdataLengthThreshold && entityCount > cdataEntityCountThreshold}
+ * <br>The default value of cdataLengthThreshold is 32.
+ * <br>
+ * <br>Use the folowing values for these cases:
* <table border=1>
+ * <caption>Option matrix</caption>
* <tr><th>Scenario</th> <th>cdataLengthThreshold</th> <th>cdataEntityCountThreshold</th></tr>
* <tr><td>Every text is CDATA</td> <td>0</td> <td>-1</td></tr>
* <tr><td>Only text that has an entity is CDATA</td> <td>0</td> <td>0</td></tr>
@@ -588,8 +590,8 @@ public class XmlOptions implements java.
/**
* This option controls when saving will use CDATA blocks.
* CDATA will be used if the folowing condition is true:
- * <br/>textLength > cdataLengthThreshold && entityCount > cdataEntityCountThreshold
- * <br/>The default value of cdataEntityCountThreshold is 5.
+ * <br>{@code textLength > cdataLengthThreshold && entityCount > cdataEntityCountThreshold}
+ * <br>The default value of cdataEntityCountThreshold is 5.
*
* @see XmlOptions#setSaveCDataLengthThreshold(int)
*/
@@ -613,36 +615,34 @@ public class XmlOptions implements java.
*
* <p><b>Note: Due to the store representation, a CDATA will not be recognized
* if it is imediately after non CDATA text and all text following it will
- * be considered CDATA.</b><br/>
+ * be considered CDATA.</b><br>
* Example:<br>
- * <pre>
- * <a><![CDATA[cdata text]]></a> - is considered as: <a><![CDATA[cdata text]]></a>
- * <b><![CDATA[cdata text]]> regular text</b> - is considered as: <b><![CDATA[cdata text regular text]]></b>
- * <c>text <![CDATA[cdata text]]></c> - is considered as: <c>text cdata text</c>
- * </pre>
- * </p>
+ * <pre>{@code
+ * <a><![CDATA[cdata text]]></a> - is considered as: <a><![CDATA[cdata text]]></a>
+ * <b><![CDATA[cdata text]]> regular text</b> - is considered as: <b><![CDATA[cdata text regular text]]></b>
+ * <c>text <![CDATA[cdata text]]></c> - is considered as: <c>text cdata text</c>
+ * }</pre>
*
* <p>Sample code:
- * <pre>
- * String xmlText = "<a>\n" +
- * "<a><![CDATA[cdata text]]></a>\n" +
- * "<b><![CDATA[cdata text]]> regular text</b>\n" +
- * "<c>text <![CDATA[cdata text]]></c>\n" +
- * "</a>";
+ * <pre>{@code
+ * String xmlText = "<a>\n" +
+ * "<a><![CDATA[cdata text]]></a>\n" +
+ * "<b><![CDATA[cdata text]]> regular text</b>\n" +
+ * "<c>text <![CDATA[cdata text]]></c>\n" +
+ * "</a>";
* System.out.println(xmlText);
*
* XmlOptions opts = new XmlOptions();
* opts.setUseCDataBookmarks();
*
- * XmlObject xo = XmlObject.Factory.parse( xmlText , opts);
+ * XmlObject xo = org.apache.xmlbeans.impl.schema.XmlObjectFactory.parse( xmlText , opts);
*
* System.out.println("xo1:\n" + xo.xmlText(opts));
* System.out.println("\n");
*
* opts.setSavePrettyPrint();
* System.out.println("xo2:\n" + xo.xmlText(opts));
- * </pre>
- * </p>
+ * }</pre>
*
* @see CDataBookmark
* @see CDataBookmark#CDATA_BOOKMARK
@@ -678,7 +678,7 @@ public class XmlOptions implements java.
* given QName when parsing. If null is supplied, the document element
* is removed.
*
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
*/
public XmlOptions setLoadReplaceDocumentElement(QName replacement) {
return set(XmlOptionsKeys.LOAD_REPLACE_DOCUMENT_ELEMENT, replacement);
@@ -693,7 +693,7 @@ public class XmlOptions implements java.
* when parsing a document. Can be used to save memory on large
* documents when you know there is no mixed content.
*
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
*/
public XmlOptions setLoadStripWhitespace() {
return setLoadStripWhitespace(true);
@@ -711,7 +711,7 @@ public class XmlOptions implements java.
* If this option is set, all comments are stripped when parsing
* a document.
*
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
*/
public XmlOptions setLoadStripComments() {
return setLoadStripComments(true);
@@ -729,7 +729,7 @@ public class XmlOptions implements java.
* If this option is set, all processing instructions
* are stripped when parsing a document.
*
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
*/
public XmlOptions setLoadStripProcinsts() {
return setLoadStripProcinsts(true);
@@ -748,11 +748,11 @@ public class XmlOptions implements java.
* in the store when parsing a document. This is particularly
* useful when you want {@link XmlError} objects to contain
* line numbers.
- * <br/>Note: This adds line numbers info only for start tags.
+ * <br>Note: This adds line numbers info only for start tags.
* For line number info on end tags use:
* {@link XmlOptions#setLoadLineNumbersEndElement()}
*
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
* @see XmlError
*/
public XmlOptions setLoadLineNumbers() {
@@ -804,7 +804,7 @@ public class XmlOptions implements java.
* definitions without a target namespace.
*
* @param substNamespaces a map of document URIs to replacement URIs
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
*/
public XmlOptions setLoadSubstituteNamespaces(Map<String, String> substNamespaces) {
return set(XmlOptionsKeys.LOAD_SUBSTITUTE_NAMESPACES, substNamespaces);
@@ -821,7 +821,7 @@ public class XmlOptions implements java.
* footprint. Use this option if you are loading a large number
* of unchanging documents that will stay in memory for some time.
*
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
*/
public XmlOptions setLoadTrimTextBuffer() {
return setLoadTrimTextBuffer(true);
@@ -840,7 +840,7 @@ public class XmlOptions implements java.
* a document.
*
* @param nses additional namespace mappings
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
*/
public XmlOptions setLoadAdditionalNamespaces(Map<String, String> nses) {
return set(XmlOptionsKeys.LOAD_ADDITIONAL_NAMESPACES, nses);
@@ -860,7 +860,7 @@ public class XmlOptions implements java.
* The schema compiler uses message digests to detect and eliminate
* duplicate imported xsd files.
*
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
*/
public XmlOptions setLoadMessageDigest() {
return setLoadMessageDigest(true);
@@ -879,7 +879,7 @@ public class XmlOptions implements java.
* documents (unless an explicit entity resolver is specified).
* Use this option to turn on entity resolving by default.
*
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
*/
public XmlOptions setLoadUseDefaultResolver() {
return setLoadUseDefaultResolver(true);
@@ -900,7 +900,7 @@ public class XmlOptions implements java.
* For using the default JDK's SAX parser use:
* xmlOptions.setLoadUseXMLReader( SAXParserFactory.newInstance().newSAXParser().getXMLReader() );
*
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
*/
public XmlOptions setLoadUseXMLReader(XMLReader xmlReader) {
return set(XmlOptionsKeys.LOAD_USE_XMLREADER, xmlReader);
@@ -954,7 +954,7 @@ public class XmlOptions implements java.
* source; otherwise, for example, when parsing a String,
* you can use this option to specify the source name yourself.
*
- * @see XmlObject.Factory#parse(java.lang.String, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.lang.String, XmlOptions)
*/
public XmlOptions setDocumentSourceName(String documentSourceName) {
return set(XmlOptionsKeys.DOCUMENT_SOURCE_NAME, documentSourceName);
@@ -965,9 +965,9 @@ public class XmlOptions implements java.
}
/**
- * This option allows for <code>QName</code> substitution during schema compilation.
+ * This option allows for {@code QName} substitution during schema compilation.
*
- * @param nameMap a map from <code>QName</code>s to substitute <code>QName</code>s.
+ * @param nameMap a map from {@code QName}s to substitute {@code QName}s.
* @see XmlBeans#compileXsd
*/
public XmlOptions setCompileSubstituteNames(Map<QName, QName> nameMap) {
@@ -981,7 +981,7 @@ public class XmlOptions implements java.
/**
* If this option is set, validation is not done on the Schema XmlBeans
- * when building a <code>SchemaTypeSystem</code>
+ * when building a {@code SchemaTypeSystem}
*
* @see XmlBeans#compileXsd
*/
@@ -995,7 +995,7 @@ public class XmlOptions implements java.
/**
* If this option is set, the unique particle attribution rule is not
- * enforced when building a <code>SchemaTypeSystem</code>. See
+ * enforced when building a {@code SchemaTypeSystem}. See
* <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#non-ambig">Appendix H of the XML Schema specification</a>
* for information on the UPA rule.
*
@@ -1015,7 +1015,7 @@ public class XmlOptions implements java.
/**
* If this option is set, the particle valid (restriciton) rule is not
- * enforced when building a <code>SchemaTypeSystem</code>. See
+ * enforced when building a {@code SchemaTypeSystem}. See
* <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#cos-particle-restrict">Section 3.9.6 of the XML Schema specification</a>
* for information on the PVR rule.
*
@@ -1110,7 +1110,7 @@ public class XmlOptions implements java.
* is introducing invalid values in an XML document, but it
* slows performance.
*
- * @see XmlObject.Factory#parse(java.io.File, XmlOptions)
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#parse(java.io.File, XmlOptions)
*/
public XmlOptions setValidateOnSet() {
return setValidateOnSet(true);
@@ -1125,7 +1125,7 @@ public class XmlOptions implements java.
}
/**
- * Instructs the validator to skip elements matching an <any>
+ * Instructs the validator to skip elements matching an {@code <any>}
* particle with contentModel="lax". This is useful because,
* in certain situations, XmlBeans will find types on the
* classpath that the document author did not anticipate.
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlSaxHandler.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlSaxHandler.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlSaxHandler.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlSaxHandler.java Fri Dec 31 00:01:16 2021
@@ -15,17 +15,17 @@
package org.apache.xmlbeans;
-import javax.xml.namespace.QName;
-
import org.xml.sax.ContentHandler;
import org.xml.sax.ext.LexicalHandler;
+import javax.xml.namespace.QName;
+
/**
* A holder for a SAX {@link ContentHandler} and {@link LexicalHandler} that are
* capable of loading an {@link XmlObject} instance. Once all the SAX events are pushed
* to the handlers, call {@link #getObject()} to get the loaded XmlObject.
- *
- * @see XmlObject.Factory#newXmlSaxHandler
+ *
+ * @see org.apache.xmlbeans.impl.schema.XmlObjectFactory#newXmlSaxHandler
* @see SchemaTypeLoader#newXmlSaxHandler
*/
public interface XmlSaxHandler
@@ -33,25 +33,25 @@ public interface XmlSaxHandler
/**
* The ContentHandler expecting SAX content events.
* @see ContentHandler
- */
+ */
ContentHandler getContentHandler ( );
-
+
/**
* The LexicalHandler expecting SAX lexical events.
* @see LexicalHandler
- */
+ */
LexicalHandler getLexicalHandler ( );
-
+
/**
* Insert a bookmark before the token associated with the last SAX event.
- */
+ */
void bookmarkLastEvent ( XmlCursor.XmlBookmark mark );
-
+
/**
* Insert a bookmark before the attr token associated with the last SAX element event.
- */
+ */
void bookmarkLastAttr ( QName attrName, XmlCursor.XmlBookmark mark );
-
+
/** Returns the loaded XmlObject after all the SAX events have been finished */
XmlObject getObject ( ) throws XmlException;
}
\ No newline at end of file
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlToken.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlToken.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlToken.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlToken.java Fri Dec 31 00:01:16 2021
@@ -28,8 +28,8 @@ import org.apache.xmlbeans.impl.schema.X
* and furthermore, all contiguous runs of space are collapsed to single spaces,
* and leading and trailing spaces are trimmed.
* <p>
- * If you want <code>" high priority "</code>
- * to be equivalent to <code>"high priority"</code>, you should consider
+ * If you want {@code " high priority "}
+ * to be equivalent to {@code "high priority"}, you should consider
* using xs:token or a subtype of xs:token.
* <p>
* When the {@link #getStringValue()} is obtained from an XmlToken, the normalized,
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlTokenSource.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlTokenSource.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlTokenSource.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlTokenSource.java Fri Dec 31 00:01:16 2021
@@ -193,6 +193,7 @@ public interface XmlTokenSource {
* an attribute).
*
* <table>
+ * <caption>Method overview</caption>
* <tr><th>To specify this</th><th>Use this method</th></tr>
* <tr>
* <td>The character encoding to use when converting the character
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlUnsignedLong.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlUnsignedLong.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlUnsignedLong.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlUnsignedLong.java Fri Dec 31 00:01:16 2021
@@ -25,7 +25,7 @@ import java.math.BigInteger;
* <a target="_blank" href="http://www.w3.org/TR/xmlschema-2/#unsignedLong">xs:unsignedLong</a> type.
* One of the derived types based on <a target="_blank" href="http://www.w3.org/TR/xmlschema-2/#decimal">xs:decimal</a>.
* <p>
- * Verified to be in the range 0..2<super>64</super>-1 when validating.
+ * Verified to be in the range 0..2^64 -1 when validating.
* <p>
* Convertible to {@link BigInteger}.
*/
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlValidationError.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlValidationError.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlValidationError.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/XmlValidationError.java Fri Dec 31 00:01:16 2021
@@ -18,10 +18,9 @@
*/
package org.apache.xmlbeans;
-import java.util.List;
-
import javax.xml.namespace.QName;
import javax.xml.stream.Location;
+import java.util.List;
/**
* The XmlValidationError class extends the {@link XmlError }XMLError class. The XML Validator contains
@@ -29,7 +28,7 @@ import javax.xml.stream.Location;
* <p>
* To extract the validation error cast the errors to XmlValidationError instead of
* XmlError for example:
- * <br/>
+ * <br>
* <pre>
* xobj.validate(new XmlOptions().setErrorListener(errors))
* for (Iterator it = errors.iterator(); it.hasNext(); )
@@ -56,54 +55,54 @@ import javax.xml.stream.Location;
* XMLValidationError are populated based on the error type.
* </p>
* if errortype == INCORRECT_ELEMENT then
- * <br/>
+ * <br>
* offendingQName, badSchemaType will always be present, however expectedSchemaType and
* expectedQNames are available only if it is possible to determine them during vaildation.
- *<br/>
+ *<br>
*
* <p>
* if errortype == ELEMENT_NOT_ALLOWED then
- * <br/>
+ * <br>
* badSchemaType will always be present, however expectedSchemaType and
* offendingQName are available only if it is possible to determine them during vaildation.
- * <br/>
+ * <br>
*
* <p>
* if errortype == INCORRECT_ATTRIBUTE then
- * <br/>
+ * <br>
* offendingQName, badSchemaType will always be present
- * <br/>
+ * <br>
*
* <p>
* if errortype == ATTRIBUTE_TYPE_INVALID then
- * <br/>
+ * <br>
* no other addtional attributes are populated
- * <br/>
+ * <br>
*
* <p>
* if errortype == LIST_INVALID then
- * <br/>
+ * <br>
* expectedSchemaType will always be present
- * <br/>
+ * <br>
*
* <p>
* if errortype == UNION_INVALID then
- * <br/>
+ * <br>
* expectedSchemaType will always be present
- * <br/>
+ * <br>
*
*
* <p>
* if errortype == NIL_ELEMENT then
- * <br/>
+ * <br>
* offendingQName, expectedSchemaType and badSchemaType will always be present
- * <br/>
+ * <br>
*
* <p>
* if errortype == ELEMENT_TYPE_INVALID then
- * <br/>
+ * <br>
* offendingQName will always be present, other attributes may be available
- * <br/>
+ * <br>
*/
public class XmlValidationError extends XmlError
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org