Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 330497 - JAXB: should modify JAXBContext javadocs to explain bootstrapping and accepted metadata formats
Summary: JAXB: should modify JAXBContext javadocs to explain bootstrapping and accepte...
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Eclipselink (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Nobody - feel free to take it CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-11-17 13:24 EST by David McCann CLA
Modified: 2022-06-09 10:27 EDT (History)
0 users

See Also:


Attachments
Proposed fix (4.59 KB, patch)
2010-12-10 16:01 EST, David McCann CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description David McCann CLA 2010-11-17 13:24:34 EST

    
Comment 1 David McCann CLA 2010-11-17 13:28:44 EST
We should update the class comment java docs on JAXBContext to outline how the external bindings file can be passed to the context.  The following should be included along with any other pertinent information:

     * It is assumed that the given map's key will be ECLIPSELINK_OXM_XML_KEY,
     * and the value will be:
     * 
     * 1)  Map<String, Object>
     *     - Object is one of those listed in 3) below
     * 2)  List<Object>
     *     - Object is one of those listed in 3) below
     *     - Bindings file must contain package-name attribute on 
     *       xml-bindings element
     * 3)  One of:
     *     - java.io.File
     *     - java.io.InputStream
     *     - java.io.Reader
     *     - java.net.URL
     *     - javax.xml.stream.XMLEventReader
     *     - javax.xml.stream.XMLStreamReader
     *     - javax.xml.transform.Source
     *     - org.w3c.dom.Node
     *     - org.xml.sax.InputSource
     *      
     *     - Bindings file must contain package-name attribute on 
     *       xml-bindings element
Comment 2 David McCann CLA 2010-11-17 13:31:28 EST
The following page should be updated as well:

http://wiki.eclipse.org/EclipseLink/DesignDocs/277920/Phase1#Bootstrapping_-_Specifying_Source_of_XML_Overrides
Comment 3 David McCann CLA 2010-12-10 16:01:33 EST
Created attachment 184998 [details]
Proposed fix
Comment 4 David McCann CLA 2010-12-10 16:03:06 EST
Reviewed by:  blaise.doughan@oracle.com
Tests:  JavaDoc change, n/a
Comment 5 David McCann CLA 2010-12-10 16:09:54 EST
Revision 8690
Comment 6 Eclipse Webmaster CLA 2022-06-09 10:27:22 EDT
The Eclipselink project has moved to Github: https://github.com/eclipse-ee4j/eclipselink