- * The JAXBContext class provides the client's entry point to the + * The {@code JAXBContext} class provides the client's entry point to the * JAXB API. It provides an abstraction for managing the XML/Java binding * information necessary to implement the JAXB binding framework operations: * unmarshal, marshal and validate. @@ -62,16 +61,16 @@ *
* The following JAXB 1.0 requirement is only required for schema to * java interface/implementation binding. It does not apply to JAXB annotated - * classes. JAXB Providers must generate a jaxb.properties file in + * classes. JAXB Providers must generate a {@code jaxb.properties} file in * each package containing schema derived classes. The property file must - * contain a property named javax.xml.bind.context.factory whose - * value is the name of the class that implements the createContext + * contain a property named {@code javax.xml.bind.context.factory} whose + * value is the name of the class that implements the {@code createContext} * APIs. * *
* The class supplied by the provider does not have to be assignable to - * javax.xml.bind.JAXBContext, it simply has to provide a class that - * implements the createContext APIs. + * {@code javax.xml.bind.JAXBContext}, it simply has to provide a class that + * implements the {@code createContext} APIs. * *
* In addition, the provider must call the
@@ -91,13 +90,13 @@
* Additionally, the unmarshal method allows for an unrecognized root element that
* has an xsi:type attribute's value that references a type definition declared in
* the schema to be unmarshalled as the root of an instance document.
- * The JAXBContext object
+ * The {@code JAXBContext} object
* allows the merging of global elements and type definitions across a set of schemas (listed
- * in the contextPath). Since each schema in the schema set can belong
+ * in the {@code contextPath}). Since each schema in the schema set can belong
* to distinct namespaces, the unification of schemas to an unmarshalling
* context should be namespace independent. This means that a client
* application is able to unmarshal XML documents that are instances of
- * any of the schemas listed in the contextPath. For example:
+ * any of the schemas listed in the {@code contextPath}. For example:
*
*
- * For more information on the generated ObjectFactory classes, see
+ * For more information on the generated {@code ObjectFactory} classes, see
* Section 4.2 Java Package of the specification.
*
*
* The provider must generate a class in each
* package that contains all of the necessary object factory methods for that
* package named ObjectFactory as well as the static
- * newInstance( javaContentInterface ) method
+ * {@code newInstance( javaContentInterface )} method
* JAXBContext jc = JAXBContext.newInstance( "com.acme.foo:com.acme.bar" );
@@ -114,12 +113,12 @@
* For schema-derived interface/implementation classes and for the
* creation of elements that are not bound to a JAXB-annotated
* class, an application needs to have access and knowledge about each of
- * the schema derived ObjectFactory classes that exist in each of
- * java packages contained in the contextPath. For each schema
+ * the schema derived {@code ObjectFactory} classes that exist in each of
+ * java packages contained in the {@code contextPath}. For each schema
* derived java class, there is a static factory method that produces objects
* of that type. For example,
- * assume that after compiling a schema, you have a package com.acme.foo
- * that contains a schema derived interface named PurchaseOrder. In
+ * assume that after compiling a schema, you have a package {@code com.acme.foo}
+ * that contains a schema derived interface named {@code PurchaseOrder}. In
* order to create objects of that type, the client application would use the
* factory method like this:
*
@@ -133,25 +132,25 @@
* it can use the mutator methods to set content on it.
*
*
*
*
* The {@link Marshaller} class provides the client application the ability * to convert a Java content tree back into XML data. There is no difference * between marshalling a content tree that is created manually using the factory - * methods and marshalling a content tree that is the result an unmarshal - * operation. Clients can marshal a java content tree back to XML data - * to a java.io.OutputStream or a java.io.Writer. The + * methods and marshalling a content tree that is the result an {@code unmarshal} + * operation. Clients can marshal a java content tree back to XML data + * to a {@code java.io.OutputStream} or a {@code java.io.Writer}. The * marshalling process can alternatively produce SAX2 event streams to a - * registered ContentHandler or produce a DOM Node object. + * registered {@code ContentHandler} or produce a DOM Node object. * Client applications have control over the output encoding as well as * whether or not to marshal the XML data as a complete document or * as a fragment. @@ -178,7 +177,7 @@ * Validation has been changed significantly since JAXB 1.0. The {@link Validator} * class has been deprecated and made optional. This means that you are advised * not to use this class and, in fact, it may not even be available depending on - * your JAXB provider. JAXB 1.0 client applications that rely on Validator + * your JAXB provider. JAXB 1.0 client applications that rely on {@code Validator} * will still work properly when deployed with the JAXB 1.0 runtime system. * * In JAXB 2.0, the {@link Unmarshaller} has included convenince methods that expose @@ -192,8 +191,8 @@ * The following JAXB 1.0 restriction only applies to binding schema to * interfaces/implementation classes. * Since this binding does not require a common runtime system, a JAXB - * client application must not attempt to mix runtime objects (JAXBContext, - * Marshaller, etc. ) from different providers. This does not + * client application must not attempt to mix runtime objects ({@code JAXBContext, + * Marshaller}, etc. ) from different providers. This does not * mean that the client application isn't portable, it simply means that a * client has to use a runtime system provided by the same provider that was * used to compile the schema. @@ -201,14 +200,14 @@ * *
- * When one of the newInstance methods is called, a JAXB implementation is discovered + * When one of the {@code newInstance} methods is called, a JAXB implementation is discovered * by the following steps. * *
Service discovery method using file /META-INF/services/javax.xml.bind.JAXBContext (described in step 4) * and leveraging provider's static methods is supported only to allow backwards compatibility, but it is strongly @@ -294,7 +291,7 @@ /** * The name of the property that contains the name of the class capable - * of creating new JAXBContext objects. + * of creating new {@code JAXBContext} objects. */ public static final String JAXB_CONTEXT_FACTORY = "javax.xml.bind.JAXBContextFactory"; @@ -303,8 +300,7 @@ /** - *
- * Create a new instance of a JAXBContext class. + * Create a new instance of a {@code JAXBContext} class. * *
* This is a convenience method to invoke the @@ -312,7 +308,7 @@ * the context class loader of the current thread. * * @throws JAXBException if an error was encountered while creating the - * JAXBContext such as + * {@code JAXBContext} such as *
- * Create a new instance of a JAXBContext class. + * Create a new instance of a {@code JAXBContext} class. * *
* The client application must supply a context path which is a list of @@ -340,7 +335,7 @@ * ObjectFactory.class generated per package. * Alternatively than being listed in the context path, programmer * annotated JAXB mapped classes can be listed in a - * jaxb.index resource file, format described below. + * {@code jaxb.index} resource file, format described below. * Note that a java package can contain both schema-derived classes and * user annotated JAXB classes. Additionally, the java package may * contain JAXB package annotations that must be processed. (see JLS, @@ -349,7 +344,7 @@ * *
* Every package listed on the contextPath must meet one or both of the - * following conditions otherwise a JAXBException will be thrown: + * following conditions otherwise a {@code JAXBException} will be thrown: *
*- * Constraints on class name occuring in a jaxb.index file are: + * Constraints on class name occuring in a {@code jaxb.index} file are: *
* To maintain compatibility with JAXB 1.0 schema to java
* interface/implementation binding, enabled by schema customization
- * {@literal
* If there are any global XML element name collisions across the various
- * packages listed on the contextPath, a JAXBException
+ * packages listed on the {@code contextPath}, a {@code JAXBException}
* will be thrown.
*
*
* Mixing generated interface/impl bindings from multiple JAXB Providers
- * in the same context path may result in a JAXBException
+ * in the same context path may result in a {@code JAXBException}
* being thrown.
*
*
@@ -408,9 +403,9 @@
* This class loader will be used to locate the implementation
* classes.
*
- * @return a new instance of a JAXBContext
+ * @return a new instance of a {@code JAXBContext}
* @throws JAXBException if an error was encountered while creating the
- * JAXBContext such as
+ * {@code JAXBContext} such as
*
- * Create a new instance of a JAXBContext class.
+ * Create a new instance of a {@code JAXBContext} class.
*
*
* This is mostly the same as {@link JAXBContext#newInstance(String, ClassLoader)},
@@ -434,7 +428,7 @@
*
*
* The interpretation of properties is up to implementations. Implementations should
- * throw JAXBException if it finds properties that it doesn't understand.
+ * throw {@code JAXBException} if it finds properties that it doesn't understand.
*
* @param contextPath list of java package names that contain schema derived classes
* @param classLoader
@@ -443,9 +437,9 @@
* provider-specific properties. Can be null, which means the same thing as passing
* in an empty map.
*
- * @return a new instance of a JAXBContext
+ * @return a new instance of a {@code JAXBContext}
* @throws JAXBException if an error was encountered while creating the
- * JAXBContext such as
+ * {@code JAXBContext} such as
*
-// * Create a new instance of a JAXBContext class.
+// * Create a new instance of a {@code JAXBContext} class.
// *
// *
// * The client application must supply a list of classes that the new
@@ -484,8 +477,8 @@
// * referenced statically from the specified classes.
// *
// * For example, in the following Java code, if you do
-// * newInstance(Foo.class), the newly created {@link JAXBContext}
-// * will recognize both Foo and Bar, but not Zot:
+// * {@code newInstance(Foo.class)}, the newly created {@link JAXBContext}
+// * will recognize both {@code Foo} and {@code Bar}, but not {@code Zot}:
// *
- * Create a new instance of a JAXBContext class.
+ * Create a new instance of a {@code JAXBContext} class.
*
*
* The client application must supply a list of classes that the new
@@ -556,12 +548,12 @@
* Not only the new context will recognize all the classes specified,
* but it will also recognize any classes that are directly/indirectly
* referenced statically from the specified classes. Subclasses of
- * referenced classes nor @XmlTransient referenced classes
+ * referenced classes nor {@code @XmlTransient} referenced classes
* are not registered with JAXBContext.
*
* For example, in the following Java code, if you do
- * newInstance(Foo.class), the newly created {@link JAXBContext}
- * will recognize both Foo and Bar, but not Zot or FooBar:
+ * {@code newInstance(Foo.class)}, the newly created {@link JAXBContext}
+ * will recognize both {@code Foo} and {@code Bar}, but not {@code Zot} or {@code FooBar}:
*
- * Create a new instance of a JAXBContext class.
+ * Create a new instance of a {@code JAXBContext} class.
*
*
* An overloading of {@link JAXBContext#newInstance(Class...)}
@@ -624,7 +615,7 @@
*
*
* The interpretation of properties is up to implementations. Implementations should
- * throw JAXBException if it finds properties that it doesn't understand.
+ * throw {@code JAXBException} if it finds properties that it doesn't understand.
*
* @param classesToBeBound
* list of java classes to be recognized by the new {@link JAXBContext}.
@@ -635,11 +626,11 @@
* in an empty map.
*
* @return
- * A new instance of a JAXBContext.
+ * A new instance of a {@code JAXBContext}.
*
* @throws JAXBException
* if an error was encountered while creating the
- * JAXBContext, such as (but not limited to):
+ * {@code JAXBContext}, such as (but not limited to):
*
- * Create a Validator object that can be used to validate a
+ * Create a {@code Validator} object that can be used to validate a
* java content tree against its source schema.
*
- * @return a Validator object
+ * @return a {@code Validator} object
*
* @throws JAXBException if an error was encountered while creating the
- * Validator object
+ * {@code Validator} object
* @deprecated since JAXB2.0
*/
public abstract Validator createValidator() throws JAXBException;
/**
- * Creates a Binder object that can be used for
+ * Creates a {@code Binder} object that can be used for
* associative/in-place unmarshalling/marshalling.
*
* @param domType select the DOM API to use by passing in its DOM Node class.
*
- * @return always a new valid Binder object.
+ * @return always a new valid {@code Binder} object.
*
* @throws UnsupportedOperationException
- * if DOM API corresponding to domType is not supported by
+ * if DOM API corresponding to {@code domType} is not supported by
* the implementation.
*
* @since 1.6, JAXB 2.0
@@ -731,9 +722,9 @@
}
/**
- * Creates a Binder for W3C DOM.
+ * Creates a {@code Binder} for W3C DOM.
*
- * @return always a new valid Binder object.
+ * @return always a new valid {@code Binder} object.
*
* @since 1.6, JAXB 2.0
*/
@@ -742,11 +733,11 @@
}
/**
- * Creates a JAXBIntrospector object that can be used to
+ * Creates a {@code JAXBIntrospector} object that can be used to
* introspect JAXB objects.
*
* @return
- * always return a non-null valid JAXBIntrospector object.
+ * always return a non-null valid {@code JAXBIntrospector} object.
*
* @throws UnsupportedOperationException
* Calling this method on JAXB 1.0 implementations will throw
diff -r f66c18528472 -r 1b48499c9e1c jaxws/src/java.xml.bind/share/classes/javax/xml/bind/annotation/package.html
--- a/jaxws/src/java.xml.bind/share/classes/javax/xml/bind/annotation/package.html Wed Jul 05 20:39:43 2017 +0200
+++ b/jaxws/src/java.xml.bind/share/classes/javax/xml/bind/annotation/package.html Thu Jul 02 18:04:32 2015 +0400
@@ -239,7 +239,7 @@
The following namespace prefixes are used in the XML Schema
- fragments in this package.
-
+ fragments in this package.
+
*
*
// * class Foo {
// * Bar b;
@@ -509,11 +502,11 @@
// * spec-defined classes will be returned.
// *
// * @return
-// * A new instance of a JAXBContext.
+// * A new instance of a {@code JAXBContext}.
// *
// * @throws JAXBException
// * if an error was encountered while creating the
-// * JAXBContext, such as (but not limited to):
+// * {@code JAXBContext}, such as (but not limited to):
// *
// *
* class Foo {
* @XmlTransient FooBar c;
@@ -589,11 +581,11 @@
* spec-defined classes will be returned.
*
* @return
- * A new instance of a JAXBContext.
+ * A new instance of a {@code JAXBContext}.
*
* @throws JAXBException
* if an error was encountered while creating the
- * JAXBContext, such as (but not limited to):
+ * {@code JAXBContext}, such as (but not limited to):
*
*
*
Notations
Namespace prefixes