|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.xml.bind.JAXBContext
com.sun.xml.bind.api.JAXBRIContext
public abstract class JAXBRIContext
JAXBContext
enhanced with JAXB RI specific functionalities.
Subject to change without notice.
Field Summary | |
---|---|
static java.lang.String |
CANONICALIZATION_SUPPORT
The property that you can specify to JAXBContext.newInstance(java.lang.String)
and Marshaller.setProperty(String, Object)
to enable the c14n marshalling support in the JAXBContext . |
static java.lang.String |
DEFAULT_NAMESPACE_REMAP
The property that you can specify to JAXBContext.newInstance(java.lang.String)
to reassign the default namespace URI to something else at the runtime. |
static java.lang.String |
ENABLE_XOP
Marshaller/Unmarshaller property to enable XOP processing. |
static java.lang.String |
TYPE_REFERENCES
The property that you can specify to JAXBContext.newInstance(java.lang.String)
to put additional JAXB type references into the JAXBContext . |
Fields inherited from class javax.xml.bind.JAXBContext |
---|
JAXB_CONTEXT_FACTORY |
Constructor Summary | |
---|---|
protected |
JAXBRIContext()
|
Method Summary | ||
---|---|---|
abstract Bridge |
createBridge(TypeReference ref)
Creates a mini-marshaller/unmarshaller that can process a TypeReference . |
|
abstract BridgeContext |
createBridgeContext()
Creates a new BridgeContext instance. |
|
abstract void |
generateSchema(javax.xml.bind.SchemaOutputResolver outputResolver)
Generates the schema documents from the model. |
|
abstract java.lang.String |
getBuildId()
Gets the build information of the JAXB runtime. |
|
abstract javax.xml.namespace.QName |
getElementName(java.lang.Object o)
If the given object is bound to an element in XML by JAXB, returns the element name. |
|
abstract
|
getElementPropertyAccessor(java.lang.Class<B> wrapperBean,
java.lang.String nsUri,
java.lang.String localName)
Gets a RawAccessor for the specified element property of the specified wrapper bean class. |
|
abstract java.util.List<java.lang.String> |
getKnownNamespaceURIs()
Gets the namespace URIs statically known to this JAXBContext . |
|
abstract javax.xml.namespace.QName |
getTypeName(TypeReference tr)
Returns the name of the XML Type bound to the specified Java type. |
|
static java.lang.String |
mangleNameToClassName(java.lang.String localName)
Computes a Java class name from a local name. |
|
static java.lang.String |
mangleNameToVariableName(java.lang.String localName)
Computes a Java identifier from a local name. |
|
static JAXBRIContext |
newInstance(java.lang.Class[] classes,
java.util.Collection<TypeReference> typeRefs,
java.lang.String defaultNamespaceRemap,
boolean c14nSupport)
Creates a new JAXBRIContext . |
Methods inherited from class javax.xml.bind.JAXBContext |
---|
createBinder, createBinder, createJAXBIntrospector, createMarshaller, createUnmarshaller, createValidator, newInstance, newInstance, newInstance, newInstance, newInstance |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_NAMESPACE_REMAP
JAXBContext.newInstance(java.lang.String)
to reassign the default namespace URI to something else at the runtime.
The value of the property is String
, and it is used as the namespace URI
that succeeds the default namespace URI.
public static final java.lang.String TYPE_REFERENCES
JAXBContext.newInstance(java.lang.String)
to put additional JAXB type references into the JAXBContext
.
The value of the property is Collection
<TypeReference
>.
Those TypeReference
s can then be used to create Bridge
s.
This mechanism allows additional element declarations that were not a part of
the schema into the created JAXBContext
.
public static final java.lang.String CANONICALIZATION_SUPPORT
JAXBContext.newInstance(java.lang.String)
and Marshaller.setProperty(String, Object)
to enable the c14n marshalling support in the JAXBContext
.
C14nSupport_ArchitectureDocument
,
Constant Field Valuespublic static final java.lang.String ENABLE_XOP
Constructor Detail |
---|
protected JAXBRIContext()
Method Detail |
---|
public static final JAXBRIContext newInstance(java.lang.Class[] classes, java.util.Collection<TypeReference> typeRefs, java.lang.String defaultNamespaceRemap, boolean c14nSupport) throws javax.xml.bind.JAXBException
JAXBRIContext
.
JAXBContext.newInstance()
methods may
return other JAXB providers that are not compatible with the JAX-RPC RI.
This method guarantees that the JAX-WS RI will finds the JAXB RI.
classes
- Classes to be bound. See JAXBContext.newInstance(Class[])
for the meaning.typeRefs
- See TYPE_REFERENCES
for the meaning of this parameter.
Can be null.defaultNamespaceRemap
- See DEFAULT_NAMESPACE_REMAP
for the meaning of this parameter.
Can be null (and should be null for ordinary use of JAXB.)c14nSupport
- See CANONICALIZATION_SUPPORT
for the meaning of this parameter.
javax.xml.bind.JAXBException
public abstract javax.xml.namespace.QName getElementName(java.lang.Object o) throws javax.xml.bind.JAXBException
javax.xml.bind.JAXBException
- if the object is not known to this context.public abstract Bridge createBridge(TypeReference ref)
TypeReference
.
newInstance(java.lang.Class[], java.util.Collection, java.lang.String, boolean)
.public abstract BridgeContext createBridgeContext()
BridgeContext
instance.
public abstract <B,V> RawAccessor<B,V> getElementPropertyAccessor(java.lang.Class<B> wrapperBean, java.lang.String nsUri, java.lang.String localName) throws javax.xml.bind.JAXBException
RawAccessor
for the specified element property of the specified wrapper bean class.
This method is designed to assist the JAX-RPC RI fill in a wrapper bean (in the doc/lit/wrap mode.) In the said mode, a wrapper bean is supposed to only have properties that match elements, and for each element that appear in the content model there's one property.
Therefore, this method takes a wrapper bean and a tag name that identifies a property
on the given wrapper bean, then returns a RawAccessor
that allows the caller
to set/get a value from the property of the bean.
This method is not designed for a performance. The caller is expected to cache the result.
B
- type of the wrapper beanV
- type of the property of the bean
javax.xml.bind.JAXBException
- if the specified wrapper bean is not bound by JAXB, or if it doesn't have an element property
of the given name.public abstract java.util.List<java.lang.String> getKnownNamespaceURIs()
JAXBContext
.
When JAXB is used to marshal into sub-trees, it declares these namespace URIs at each top-level element that it marshals. To avoid repeated namespace declarations at sub-elements, the application may declare those namespaces at a higher level.
public abstract void generateSchema(javax.xml.bind.SchemaOutputResolver outputResolver) throws java.io.IOException
The caller can use the additionalElementDecls parameter to add element declarations to the generate schema. For example, if the JAX-RPC passes in the following entry: {foo}bar -> DeclaredType for java.lang.String then JAXB generates the following element declaration (in the schema document for the namespace "foo")" <xs:element name="bar" type="xs:string" /> This can be used for generating schema components necessary for WSDL.
generateSchema
in class javax.xml.bind.JAXBContext
outputResolver
- this object controls the output to which schemas
will be sent.
java.io.IOException
- if SchemaOutputResolver
throws an IOException
.public abstract javax.xml.namespace.QName getTypeName(TypeReference tr)
tr
- must not be null. This must be one of the TypeReference
s specified
in the newInstance(java.lang.Class[], java.util.Collection, java.lang.String, boolean)
method.
java.lang.IllegalArgumentException
- if the parameter is null or not a part of the TypeReference
s specified
in the newInstance(java.lang.Class[], java.util.Collection, java.lang.String, boolean)
method.public abstract java.lang.String getBuildId()
public static java.lang.String mangleNameToVariableName(java.lang.String localName)
This method faithfully implements the name mangling rule as specified in the JAXB spec.
In JAXB, a collision with a Java reserved word (such as "return") never happens. Accordingly, this method may return an identifier that collides with reserved words.
Use JJavaName#isJavaIdentifier(String)
to check for such collision.
JJavaName#isJavaIdentifier(String)
public static java.lang.String mangleNameToClassName(java.lang.String localName)
This method faithfully implements the name mangling rule as specified in the JAXB spec.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |