* This is a convenience method of: - *
- * updateXML( jaxbObject, getXMLNode(jaxbObject)); - *+ * {@snippet : + * updateXML( jaxbObject, getXMLNode(jaxbObject)); + * } * * @param jaxbObject the XML Binding object * diff --git a/api/src/main/java/jakarta/xml/bind/DatatypeConverter.java b/api/src/main/java/jakarta/xml/bind/DatatypeConverter.java index 27549e4..f40c844 100644 --- a/api/src/main/java/jakarta/xml/bind/DatatypeConverter.java +++ b/api/src/main/java/jakarta/xml/bind/DatatypeConverter.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -28,23 +28,21 @@ * implementation of parse and print methods. These methods are invoked by * custom parse and print methods. For example, the binding of xsd:dateTime * to a long can be customized using parse and print methods as follows: - *
- *
- * // Customized parse method
- * public long myParseCal( String dateTimeString ) {
- * java.util.Calendar cal = DatatypeConverter.parseDateTime(dateTimeString);
- * long longval = convert_calendar_to_long(cal); //application specific
- * return longval;
- * }
- *
- * // Customized print method
- * public String myPrintCal( Long longval ) {
- * java.util.Calendar cal = convert_long_to_calendar(longval) ; //application specific
- * String dateTimeString = DatatypeConverter.printDateTime(cal);
- * return dateTimeString;
- * }
- *
- *
+ * {@snippet :
+ * // Customized parse method
+ * public long myParseCal( String dateTimeString ) {
+ * java.util.Calendar cal = DatatypeConverter.parseDateTime(dateTimeString);
+ * long longval = convert_calendar_to_long(cal); //application specific
+ * return longval;
+ * }
+ *
+ * // Customized print method
+ * public String myPrintCal( Long longval ) {
+ * java.util.Calendar cal = convert_long_to_calendar(longval) ; //application specific
+ * String dateTimeString = DatatypeConverter.printDateTime(cal);
+ * return dateTimeString;
+ * }
+ * }
* * There is a static parse and print method corresponding to each parse and * print method respectively in the {@link DatatypeConverterInterface @@ -75,7 +73,6 @@ * @see PrintConversionEvent * @since 1.6, JAXB 1.0 */ - final public class DatatypeConverter { // delegate to this instance of DatatypeConverter diff --git a/api/src/main/java/jakarta/xml/bind/JAXBContext.java b/api/src/main/java/jakarta/xml/bind/JAXBContext.java index f2295f0..e25266c 100644 --- a/api/src/main/java/jakarta/xml/bind/JAXBContext.java +++ b/api/src/main/java/jakarta/xml/bind/JAXBContext.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -67,13 +67,13 @@ * application is able to unmarshal XML documents that are instances of * any of the schemas listed in the {@code contextPath}. For example: * - *
- * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo:com.acme.bar" ); - * Unmarshaller u = jc.createUnmarshaller(); - * FooObject fooObj = (FooObject)u.unmarshal( new File( "foo.xml" ) ); // ok - * BarObject barObj = (BarObject)u.unmarshal( new File( "bar.xml" ) ); // ok - * BazObject bazObj = (BazObject)u.unmarshal( new File( "baz.xml" ) ); // error, "com.acme.baz" not in contextPath - *+ * {@snippet : + * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo:com.acme.bar" ); + * Unmarshaller u = jc.createUnmarshaller(); + * FooObject fooObj = (FooObject)u.unmarshal( new File( "foo.xml" ) ); // ok + * BarObject barObj = (BarObject)u.unmarshal( new File( "bar.xml" ) ); // ok + * BazObject bazObj = (BazObject)u.unmarshal( new File( "baz.xml" ) ); // error, "com.acme.baz" not in contextPath + * } * *
* The client application may also generate Java content trees explicitly rather @@ -91,10 +91,10 @@ * order to create objects of that type, the client application would use the * factory method like this: * - *
- * com.acme.foo.PurchaseOrder po = - * com.acme.foo.ObjectFactory.createPurchaseOrder(); - *+ * {@snippet : + * com.acme.foo.PurchaseOrder po = + * com.acme.foo.ObjectFactory.createPurchaseOrder(); + * } * *
* Once the client application has an instance of the the schema derived object, @@ -128,17 +128,17 @@ * Here is a simple example that unmarshals an XML document and then marshals * it back out: * - *
- * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
+ * {@snippet :
+ * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
*
- * // unmarshal from foo.xml
- * Unmarshaller u = jc.createUnmarshaller();
- * FooObject fooObj = (FooObject)u.unmarshal( new File( "foo.xml" ) );
+ * // unmarshal from foo.xml
+ * Unmarshaller u = jc.createUnmarshaller();
+ * FooObject fooObj = (FooObject)u.unmarshal( new File( "foo.xml" ) );
*
- * // marshal to System.out
- * Marshaller m = jc.createMarshaller();
- * m.marshal( fooObj, System.out );
- *
+ * // marshal to System.out
+ * Marshaller m = jc.createMarshaller();
+ * m.marshal( fooObj, System.out );
+ * }
*
*
*
-// * class Foo {
-// * Bar b;
+// * {@snippet :
+// * class Foo {
+// * Bar b;
+// * }
+// * class Bar { int x; }
+// * class Zot extends Bar { int y; }
// * }
-// * class Bar { int x; }
-// * class Zot extends Bar { int y; }
-// *
// *
// * Therefore, a typical client application only needs to specify the
// * top-level classes, but it needs to be careful.
@@ -491,15 +491,15 @@ public static JAXBContext newInstance( String contextPath,
* For example, in the following Java code, if you do
* {@code newInstance(Foo.class)}, the newly created {@link JAXBContext}
* will recognize both {@code Foo} and {@code Bar}, but not {@code Zot} or {@code FooBar}:
- *
- * class Foo {
- * @XmlTransient FooBar c;
- * Bar b;
+ * {@snippet :
+ * class Foo {
+ * @XmlTransient FooBar c;
+ * Bar b;
+ * }
+ * class Bar { int x; }
+ * class Zot extends Bar { int y; }
+ * class FooBar { }
* }
- * class Bar { int x; }
- * class Zot extends Bar { int y; }
- * class FooBar { }
- *
*
* Therefore, a typical client application only needs to specify the
* top-level classes, but it needs to be careful.
diff --git a/api/src/main/java/jakarta/xml/bind/Marshaller.java b/api/src/main/java/jakarta/xml/bind/Marshaller.java
index f21c48a..c2ddac0 100644
--- a/api/src/main/java/jakarta/xml/bind/Marshaller.java
+++ b/api/src/main/java/jakarta/xml/bind/Marshaller.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2003, 2021 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
@@ -24,114 +24,92 @@
*
* * Assume the following setup code for all following code fragments: - *
- *+ * {@snippet : + * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" ); + * Unmarshaller u = jc.createUnmarshaller(); + * Object element = u.unmarshal( new File( "foo.xml" ) ); + * Marshaller m = jc.createMarshaller(); + * } * *- * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" ); - * Unmarshaller u = jc.createUnmarshaller(); - * Object element = u.unmarshal( new File( "foo.xml" ) ); - * Marshaller m = jc.createMarshaller(); - *- *
* Marshalling to a File: - *
- *+ * {@snippet : + * OutputStream os = new FileOutputStream( "nosferatu.xml" ); + * m.marshal( element, os ); + * } * *- * OutputStream os = new FileOutputStream( "nosferatu.xml" ); - * m.marshal( element, os ); - *- *
* Marshalling to a SAX ContentHandler: - *
- *+ * {@snippet : + * // assume MyContentHandler instanceof ContentHandler + * m.marshal( element, new MyContentHandler() ); + * } * *- * // assume MyContentHandler instanceof ContentHandler - * m.marshal( element, new MyContentHandler() ); - *- *
* Marshalling to a DOM Node: - *
- *
- * DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
- * dbf.setNamespaceAware(true);
- * DocumentBuilder db = dbf.newDocumentBuilder();
- * Document doc = db.newDocument();
+ * {@snippet :
+ * DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
+ * dbf.setNamespaceAware(true);
+ * DocumentBuilder db = dbf.newDocumentBuilder();
+ * Document doc = db.newDocument();
*
- * m.marshal( element, doc );
- *
- *
+ * m.marshal( element, doc );
+ * }
*
* * Marshalling to a java.io.OutputStream: - *
- *+ * {@snippet : + * m.marshal( element, System.out ); + * } * *- * m.marshal( element, System.out ); - *- *
* Marshalling to a java.io.Writer: - *
- *+ * {@snippet : + * m.marshal( element, new PrintWriter( System.out ) ); + * } * *- * m.marshal( element, new PrintWriter( System.out ) ); - *- *
* Marshalling to a javax.xml.transform.SAXResult: - *
- *
- * // assume MyContentHandler instanceof ContentHandler
- * SAXResult result = new SAXResult( new MyContentHandler() );
+ * {@snippet :
+ * // assume MyContentHandler instanceof ContentHandler
+ * SAXResult result = new SAXResult( new MyContentHandler() );
*
- * m.marshal( element, result );
- *
- *
+ * m.marshal( element, result );
+ * }
*
* * Marshalling to a javax.xml.transform.DOMResult: - *
- *
- * DOMResult result = new DOMResult();
+ * {@snippet :
+ * DOMResult result = new DOMResult();
*
- * m.marshal( element, result );
- *
- *
+ * m.marshal( element, result );
+ * }
*
* * Marshalling to a javax.xml.transform.StreamResult: - *
- *
- * StreamResult result = new StreamResult( System.out );
+ * {@snippet :
+ * StreamResult result = new StreamResult( System.out );
*
- * m.marshal( element, result );
- *
- *
+ * m.marshal( element, result );
+ * }
*
* * Marshalling to a javax.xml.stream.XMLStreamWriter: - *
- *
- * XMLStreamWriter xmlStreamWriter =
- * XMLOutputFactory.newInstance().createXMLStreamWriter( ... );
+ * {@snippet :
+ * XMLStreamWriter xmlStreamWriter =
+ * XMLOutputFactory.newInstance().createXMLStreamWriter( ... );
*
- * m.marshal( element, xmlStreamWriter );
- *
- *
+ * m.marshal( element, xmlStreamWriter );
+ * }
*
* * Marshalling to a javax.xml.stream.XMLEventWriter: - *
- *
- * XMLEventWriter xmlEventWriter =
- * XMLOutputFactory.newInstance().createXMLEventWriter( ... );
+ * {@snippet :
+ * XMLEventWriter xmlEventWriter =
+ * XMLOutputFactory.newInstance().createXMLEventWriter( ... );
*
- * m.marshal( element, xmlEventWriter );
- *
- *
+ * m.marshal( element, xmlEventWriter );
+ * }
*
* * Class defined event callback methods allow any Jakarta XML Binding mapped class to specify * its own specific callback methods by defining methods with the following method signatures: - *
- *
- * // Invoked by Marshaller after it has created an instance of this object.
- * boolean beforeMarshal(Marshaller);
+ * {@snippet :
+ * // Invoked by Marshaller after it has created an instance of this object.
+ * boolean beforeMarshal(Marshaller);
*
- * // Invoked by Marshaller after it has marshalled all properties of this object.
- * void afterMarshal(Marshaller);
- *
- *
+ * // Invoked by Marshaller after it has marshalled all properties of this object.
+ * void afterMarshal(Marshaller);
+ * }
* The class defined event callback methods should be used when the callback method requires
* access to non-public methods and/or fields of the class.
* diff --git a/api/src/main/java/jakarta/xml/bind/Unmarshaller.java b/api/src/main/java/jakarta/xml/bind/Unmarshaller.java index a43f0fe..2431771 100644 --- a/api/src/main/java/jakarta/xml/bind/Unmarshaller.java +++ b/api/src/main/java/jakarta/xml/bind/Unmarshaller.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -23,144 +23,128 @@ * *
* Unmarshalling from a File: - *
- *+ * {@snippet : + * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" ); + * Unmarshaller u = jc.createUnmarshaller(); + * Object o = u.unmarshal( new File( "nosferatu.xml" ) ); + * } * * *- * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" ); - * Unmarshaller u = jc.createUnmarshaller(); - * Object o = u.unmarshal( new File( "nosferatu.xml" ) ); - *- *
* Unmarshalling from an InputStream: - *
- *+ * {@snippet : + * InputStream is = new FileInputStream( "nosferatu.xml" ); + * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" ); + * Unmarshaller u = jc.createUnmarshaller(); + * Object o = u.unmarshal( is ); + * } * *- * InputStream is = new FileInputStream( "nosferatu.xml" ); - * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" ); - * Unmarshaller u = jc.createUnmarshaller(); - * Object o = u.unmarshal( is ); - *- *
* Unmarshalling from a URL: - *
- *+ * {@snippet : + * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" ); + * Unmarshaller u = jc.createUnmarshaller(); + * URL url = new URL( "http://beaker.east/nosferatu.xml" ); + * Object o = u.unmarshal( url ); + * } * *- * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" ); - * Unmarshaller u = jc.createUnmarshaller(); - * URL url = new URL( "http://beaker.east/nosferatu.xml" ); - * Object o = u.unmarshal( url ); - *- *
* Unmarshalling from a StringBuffer using a * {@code javax.xml.transform.stream.StreamSource}: - *
- * {@code
- * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
- * Unmarshaller u = jc.createUnmarshaller();
- * StringBuffer xmlStr = new StringBuffer( "..." );
- * Object o = u.unmarshal( new StreamSource( new StringReader( xmlStr.toString() ) ) );
- * }
- *
+ * {@snippet :
+ * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
+ * Unmarshaller u = jc.createUnmarshaller();
+ * StringBuffer xmlStr = new StringBuffer( "..." );
+ * Object o = u.unmarshal( new StreamSource( new StringReader( xmlStr.toString() ) ) );
+ * }
*
* * Unmarshalling from a {@code org.w3c.dom.Node}: - *
- *
- * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
- * Unmarshaller u = jc.createUnmarshaller();
+ * {@snippet :
+ * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
+ * Unmarshaller u = jc.createUnmarshaller();
*
- * DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
- * dbf.setNamespaceAware(true);
- * DocumentBuilder db = dbf.newDocumentBuilder();
- * Document doc = db.parse(new File( "nosferatu.xml"));
+ * DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
+ * dbf.setNamespaceAware(true);
+ * DocumentBuilder db = dbf.newDocumentBuilder();
+ * Document doc = db.parse(new File( "nosferatu.xml"));
- * Object o = u.unmarshal( doc );
- *
- *
+ * Object o = u.unmarshal( doc );
+ * }
*
* * Unmarshalling from a {@code javax.xml.transform.sax.SAXSource} using a * client specified validating SAX2.0 parser: - *
- *
- * // configure a validating SAX2.0 parser (Xerces2)
- * static final String JAXP_SCHEMA_LANGUAGE =
- * "http://java.sun.com/xml/jaxp/properties/schemaLanguage";
- * static final String JAXP_SCHEMA_LOCATION =
- * "http://java.sun.com/xml/jaxp/properties/schemaSource";
- * static final String W3C_XML_SCHEMA =
- * "http://www.w3.org/2001/XMLSchema";
+ * {@snippet :
+ * // configure a validating SAX2.0 parser (Xerces2)
+ * static final String JAXP_SCHEMA_LANGUAGE =
+ * "http://java.sun.com/xml/jaxp/properties/schemaLanguage";
+ * static final String JAXP_SCHEMA_LOCATION =
+ * "http://java.sun.com/xml/jaxp/properties/schemaSource";
+ * static final String W3C_XML_SCHEMA =
+ * "http://www.w3.org/2001/XMLSchema";
*
- * System.setProperty( "javax.xml.parsers.SAXParserFactory",
- * "org.apache.xerces.jaxp.SAXParserFactoryImpl" );
+ * System.setProperty( "javax.xml.parsers.SAXParserFactory",
+ * "org.apache.xerces.jaxp.SAXParserFactoryImpl" );
*
- * SAXParserFactory spf = SAXParserFactory.newInstance();
- * spf.setNamespaceAware(true);
- * spf.setValidating(true);
- * SAXParser saxParser = spf.newSAXParser();
+ * SAXParserFactory spf = SAXParserFactory.newInstance();
+ * spf.setNamespaceAware(true);
+ * spf.setValidating(true);
+ * SAXParser saxParser = spf.newSAXParser();
*
- * try {
- * saxParser.setProperty(JAXP_SCHEMA_LANGUAGE, W3C_XML_SCHEMA);
- * saxParser.setProperty(JAXP_SCHEMA_LOCATION, "http://....");
- * } catch (SAXNotRecognizedException x) {
- * // exception handling omitted
- * }
+ * try {
+ * saxParser.setProperty(JAXP_SCHEMA_LANGUAGE, W3C_XML_SCHEMA);
+ * saxParser.setProperty(JAXP_SCHEMA_LOCATION, "http://....");
+ * } catch (SAXNotRecognizedException x) {
+ * // exception handling omitted
+ * }
*
- * XMLReader xmlReader = saxParser.getXMLReader();
- * SAXSource source =
- * new SAXSource( xmlReader, new InputSource( "http://..." ) );
+ * XMLReader xmlReader = saxParser.getXMLReader();
+ * SAXSource source =
+ * new SAXSource( xmlReader, new InputSource( "http://..." ) );
*
- * // Setup Jakarta XML Binding to unmarshal
- * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
- * Unmarshaller u = jc.createUnmarshaller();
- * ValidationEventCollector vec = new ValidationEventCollector();
- * u.setEventHandler( vec );
+ * // Setup Jakarta XML Binding to unmarshal
+ * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
+ * Unmarshaller u = jc.createUnmarshaller();
+ * ValidationEventCollector vec = new ValidationEventCollector();
+ * u.setEventHandler( vec );
*
- * // turn off the Jakarta XML Binding provider's default validation mechanism to
- * // avoid duplicate validation
- * u.setValidating( false )
+ * // turn off the Jakarta XML Binding provider's default validation mechanism to
+ * // avoid duplicate validation
+ * u.setValidating( false )
*
- * // unmarshal
- * Object o = u.unmarshal( source );
+ * // unmarshal
+ * Object o = u.unmarshal( source );
*
- * // check for events
- * if( vec.hasEvents() ) {
- * // iterate over events
- * }
- *
- *
+ * // check for events
+ * if( vec.hasEvents() ) {
+ * // iterate over events
+ * }
+ * }
*
* * Unmarshalling from a StAX XMLStreamReader: - *
- *
- * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
- * Unmarshaller u = jc.createUnmarshaller();
+ * {@snippet :
+ * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
+ * Unmarshaller u = jc.createUnmarshaller();
*
- * javax.xml.stream.XMLStreamReader xmlStreamReader =
- * javax.xml.stream.XMLInputFactory().newInstance().createXMLStreamReader( ... );
+ * javax.xml.stream.XMLStreamReader xmlStreamReader =
+ * javax.xml.stream.XMLInputFactory().newInstance().createXMLStreamReader( ... );
*
- * Object o = u.unmarshal( xmlStreamReader );
- *
- *
+ * Object o = u.unmarshal( xmlStreamReader );
+ * }
*
* * Unmarshalling from a StAX XMLEventReader: - *
- *
- * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
- * Unmarshaller u = jc.createUnmarshaller();
+ * {@snippet :
+ * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
+ * Unmarshaller u = jc.createUnmarshaller();
*
- * javax.xml.stream.XMLEventReader xmlEventReader =
- * javax.xml.stream.XMLInputFactory().newInstance().createXMLEventReader( ... );
+ * javax.xml.stream.XMLEventReader xmlEventReader =
+ * javax.xml.stream.XMLInputFactory().newInstance().createXMLEventReader( ... );
*
- * Object o = u.unmarshal( xmlEventReader );
- *
- *
+ * Object o = u.unmarshal( xmlEventReader );
+ * }
*
* * @@ -262,37 +246,36 @@ * unmarshal by declaredType method. *
* Unmarshal by declaredType from a {@code org.w3c.dom.Node}: - *
- * {@code
- * Schema fragment for example
- *
- * ...<\xs:complexType>
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
- * Unmarshaller u = jc.createUnmarshaller();
+ * {@snippet lang="XML" :
+ *
+ *
+ * ...
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * }
+ * {@snippet :
+ * JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
+ * Unmarshaller u = jc.createUnmarshaller();
*
- * DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
- * dbf.setNamespaceAware(true);
- * DocumentBuilder db = dbf.newDocumentBuilder();
- * Document doc = db.parse(new File( "nosferatu.xml"));
- * Element fooSubtree = ...; // traverse DOM till reach xml element foo, constrained by a
- * // local element declaration in schema.
+ * DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
+ * dbf.setNamespaceAware(true);
+ * DocumentBuilder db = dbf.newDocumentBuilder();
+ * Document doc = db.parse(new File( "nosferatu.xml"));
+ * Element fooSubtree = ...; // traverse DOM till reach xml element foo, constrained by a
+ * // local element declaration in schema.
*
- * // FooType is the Jakarta XML Binding mapping of the type of local element declaration foo.
- * JAXBElement foo = u.unmarshal( fooSubtree, FooType.class);
- * }
- *
+ * // FooType is the Jakarta XML Binding mapping of the type of local element declaration foo.
+ * JAXBElement
* Support for SAX2.0 Compliant Parsers
@@ -354,17 +337,15 @@
*
* 'Class defined' event callback methods allow any Jakarta XML Binding mapped class to specify * its own specific callback methods by defining methods with the following method signature: - *
- *
- * // This method is called immediately after the object is created and before the unmarshalling of this
- * // object begins. The callback provides an opportunity to initialize JavaBean properties prior to unmarshalling.
- * void beforeUnmarshal(Unmarshaller, Object parent);
+ * {@snippet :
+ * // This method is called immediately after the object is created and before the unmarshalling of this
+ * // object begins. The callback provides an opportunity to initialize JavaBean properties prior to unmarshalling.
+ * void beforeUnmarshal(Unmarshaller, Object parent);
*
- * //This method is called after all the properties (except IDREF) are unmarshalled for this object,
- * //but before this object is set to the parent object.
- * void afterUnmarshal(Unmarshaller, Object parent);
- *
- *
+ * //This method is called after all the properties (except IDREF) are unmarshalled for this object,
+ * //but before this object is set to the parent object.
+ * void afterUnmarshal(Unmarshaller, Object parent);
+ * }
* The class defined callback methods should be used when the callback method requires
* access to non-public methods and/or fields of the class.
* diff --git a/api/src/main/java/jakarta/xml/bind/UnmarshallerHandler.java b/api/src/main/java/jakarta/xml/bind/UnmarshallerHandler.java index 4228437..8932bbf 100644 --- a/api/src/main/java/jakarta/xml/bind/UnmarshallerHandler.java +++ b/api/src/main/java/jakarta/xml/bind/UnmarshallerHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -19,22 +19,22 @@ * Applications can use this interface to use their Jakarta XML Binding provider as a component * in an XML pipeline. For example: * - *
- * JAXBContext context = JAXBContext.newInstance( "org.acme.foo" );
+ * {@snippet :
+ * JAXBContext context = JAXBContext.newInstance( "org.acme.foo" );
*
- * Unmarshaller unmarshaller = context.createUnmarshaller();
+ * Unmarshaller unmarshaller = context.createUnmarshaller();
*
- * UnmarshallerHandler unmarshallerHandler = unmarshaller.getUnmarshallerHandler();
+ * UnmarshallerHandler unmarshallerHandler = unmarshaller.getUnmarshallerHandler();
*
- * SAXParserFactory spf = SAXParserFactory.newInstance();
- * spf.setNamespaceAware( true );
+ * SAXParserFactory spf = SAXParserFactory.newInstance();
+ * spf.setNamespaceAware( true );
*
- * XMLReader xmlReader = spf.newSAXParser().getXMLReader();
- * xmlReader.setContentHandler( unmarshallerHandler );
- * xmlReader.parse(new InputSource( new FileInputStream( XML_FILE ) ) );
+ * XMLReader xmlReader = spf.newSAXParser().getXMLReader();
+ * xmlReader.setContentHandler( unmarshallerHandler );
+ * xmlReader.parse(new InputSource( new FileInputStream( XML_FILE ) ) );
*
- * MyObject myObject= (MyObject)unmarshallerHandler.getResult();
- *
+ * MyObject myObject= (MyObject)unmarshallerHandler.getResult();
+ * }
*
* * This interface is reusable: even if the user fails to unmarshal diff --git a/api/src/main/java/jakarta/xml/bind/annotation/XmlAccessorType.java b/api/src/main/java/jakarta/xml/bind/annotation/XmlAccessorType.java index 87cb24d..bc62aa8 100644 --- a/api/src/main/java/jakarta/xml/bind/annotation/XmlAccessorType.java +++ b/api/src/main/java/jakarta/xml/bind/annotation/XmlAccessorType.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -52,16 +52,16 @@ * *
By default, if {@code @XmlAccessorType} on a package is absent, * then the following package level annotation is assumed.
- *- * @XmlAccessorType(XmlAccessType.PUBLIC_MEMBER) - *+ * {@snippet : + * @XmlAccessorType(XmlAccessType.PUBLIC_MEMBER) + * } *
By default, if {@code @XmlAccessorType} on a class is absent, * and none of its super classes is annotated with * {@code @XmlAccessorType}, then the following default on the class * is assumed:
- *- * @XmlAccessorType(XmlAccessType.PUBLIC_MEMBER) - *+ * {@snippet : + * @XmlAccessorType(XmlAccessType.PUBLIC_MEMBER) + * } *
This annotation can be used with the following annotations: * {@link XmlType}, {@link XmlRootElement}, {@link XmlAccessorOrder}, * {@link XmlSchema}, {@link XmlSchemaType}, {@link XmlSchemaTypes}, @@ -72,7 +72,6 @@ * @since 1.6, JAXB 2.0 * @see XmlAccessType */ - @Inherited @Retention(RUNTIME) @Target({PACKAGE, TYPE}) public @interface XmlAccessorType { diff --git a/api/src/main/java/jakarta/xml/bind/annotation/XmlAnyElement.java b/api/src/main/java/jakarta/xml/bind/annotation/XmlAnyElement.java index 8be8ce6..863d6c0 100644 --- a/api/src/main/java/jakarta/xml/bind/annotation/XmlAnyElement.java +++ b/api/src/main/java/jakarta/xml/bind/annotation/XmlAnyElement.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -28,28 +28,28 @@ * *
* This annotation serves as a "catch-all" property while unmarshalling - * xml content into a instance of a Jakarta XML Binding annotated class. It typically - * annotates a multi-valued JavaBean property, but it can occur on + * xml content into an instance of a Jakarta XML Binding annotated class. It typically + * annotates a multivalued JavaBean property, but it can occur on * single value JavaBean property. During unmarshalling, each xml element * that does not match a static @XmlElement or @XmlElementRef * annotation for the other JavaBean properties on the class, is added to this * "catch-all" property. * *
- * @XmlAnyElement
- * public {@link Element}[] others;
+ * {@snippet :
+ * @XmlAnyElement
+ * public Element[] others;
*
- * // Collection of {@link Element} or JAXBElements.
- * @XmlAnyElement(lax="true")
- * public {@link Object}[] others;
+ * // Collection of Element or JAXBElements.
+ * @XmlAnyElement(lax="true")
+ * public Object[] others;
*
- * @XmlAnyElement
- * private List<{@link Element}> nodes;
+ * @XmlAnyElement
+ * private List nodes;
*
- * @XmlAnyElement
- * private {@link Element} node;
- *
+ * @XmlAnyElement
+ * private Element node;
+ * }
*
* @@ -69,82 +69,84 @@ * *
* This annotation can be used with {@link XmlMixed} like this: - *
- * // List of java.lang.String or DOM nodes. - * @XmlAnyElement @XmlMixed - * List<Object> others; - *+ * {@snippet : + * // List of java.lang.String or DOM nodes. + * @XmlAnyElement + * @XmlMixed + * List