com.sun.xml.bind.v2.package-info Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/**
* The JAXB 2.0 runtime
.
*
* Overview
*
* This module provides code that implements {@link JAXBContext}.
* Roughly speaking the runtime works like this:
*
*
* - There's a set of classes and interfaces that model JAXB-bound types.
* You can think of this as a reflection library for JAXB.
*
- There's a set of classes that constitute the unmarshaller and marshaller.
* Each class represents a small portion, and they are composed to perform
* the operations.
*
- {@link JAXBContextImpl} builds itself by reading the model and
* composing unmarshallers and marshallers.
*
*
* Interesting Pieces inside Runtime
*
* The followings are the interesting pieces inside the runtime.
*
*
* - {@link com.sun.xml.bind.v2.model model}
*
-
* This set of classes and interfaces models JAXB-bound types.
*
*
- {@link com.sun.xml.bind.v2.runtime XML I/O}
*
-
* This set of classes implements the JAXB API and provides the XML I/O functionality.
*
*
*
* The classes NOT in the {@link com.sun.xml.bind.v2} package (and its subpackages)
* are also used by old JAXB 1.0 clients.
*
*
Models
*
* "Model" is the portion of the code that represents JAXB-bound types.
*
*
* The following picture illustrates the relationship among major
* packages of the binding model.
*
*
* 
*
*
*
* The core model contracts are all interfaces, and they are parameterized
* so that they can be used
* with different reflection libraries. This is necessary, as the model
* is used:
*
* - at runtime to process loaded classes,
*
- at tool-time to process source files / class files, and
*
- at schema compile time to generate source code.
*
* They all use different reflection libraries.
*
*
* This portion is used by all
* three running mode of JAXB.
* The corresponding base-level implementaion
* is also parameterized.
*
*
* The runtime model contract and implementation are used only at the run-time.
* These packages fix the parameterization to the Java reflection,
* and also exposes additional functionalities to actually do the
* unmarshalling/marshalling. These classes have "Runtime" prefix.
*
*
* Finally XJC has its own implementation of the contract in
* its own package. This package also fixes the parameterization
* to its own reflection library.
*
*
* When you work on the code, it is often helpful to know the layer you are in.
*
*
*
* The binding model design roughly looks like the following.
* For more details, see the javadoc of each component.
*
*
* 
*
*
* TODO: link to classes from above pictures
*
*
* Evolution Rules
* None of the class in this package or below should be directly
* referenced by the generated code. Hence they can be changed freely
* from versions to versions.
*
*
*
*
* Performance Characteristics
*
* Model construction happens inside {@link JAXBContext#newInstance(Class[])}.
* It's desirable for this step to be fast and consume less memory,
* but it's not too performance sensitive.
*
*
* Code that implements the unmarshaller and the marshaller OTOH
* needs to be very carefully written to achieve maximum sustaining
* performance.
*
*
*
*
*
Bootstrap Sequence
*
* The following picture illustrates how the {@link JAXBContext#newInstance(Class[])} method
* triggers activities.
*
* {@SequenceDiagram
boxwid=1.2;
pobject(U,"user");
object(A,"JAXB API");
object(CF,"ContextFactory");
pobject(JC);
step();
message(U,A,"JAXBContext.newInstance()");
active(A);
message(A,A,"locate JAXB RI 2.0");
active(A);
step();
inactive(A);
message(A,CF,"createContext");
active(CF);
create_message(CF,JC,"c:JAXBContextImpl");
active(JC);
message(JC,JC,"build runtime model");
message(JC,JC,"build JaxBeanInfos");
inactive(JC);
rmessage(A,U,"return c");
inactive(CF);
inactive(A);
complete(JC);
complete(CF);
complete(A);
* }
*
* @ArchitectureDocument
*/
package com.sun.xml.bind.v2;