public abstract Class JAXBRIContext

The property that you can specify to JAXBContext#newInstance to use alternative RuntimeAnnotationReader implementation.

Since

2.1 EA2

If true and element namespace is not specified, namespace of parent element will be used. The default value is false. Boolean

Since

2.3.0

The property that you can specify to JAXBContext#newInstance and Marshaller#setProperty(String, Object) to enable the c14n marshalling support in the JAXBContext. Boolean

Since

2.0 EA2

The property that you can specify to JAXBContext#newInstance 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.

Since

2.0 EA1

If true XML security features when parsing XML documents will be disabled. The default value is false. Boolean

Since

2.2.6

Marshaller/Unmarshaller property to enable XOP processing.

Since

2.0 EA2

Improves handling of xsi:type used on leaf properties. Boolean

Since

2.2.3

The maximum number of errors to report. Use negative value to report all errors. The default value is 10. Boolean

Since

2.3.3

Retains references to PropertyInfos. Boolean

Since

2.1.10

The property that you can specify to JAXBContext#newInstance to specify specific classes that replace the reference to generic classes.

See the release notes for more details about this feature.

Since

2.1 EA2

Supress security warnings when trying to access fields through reflection. Boolean

Since

2.1.14, 2.2.2

The property that you can specify to JAXBContext#newInstance to allow unmarshaller to honor xsi:nil anywhere, even if they are not specifically allowed by the schema. Boolean

Since

2.1.3

The property that you can specify to JAXBContext#newInstance to put additional JAXB type references into the JAXBContext.

The value of the property is Collection<TypeReference>. Those TypeReferences can then be used to create Bridges.

This mechanism allows additional element declarations that were not a part of the schema into the created JAXBContext.

Since

2.0 EA1

The property that you can specify to JAXBContext#newInstance enable support of XmlAccessorFactory annotation in the JAXBContext.

Since

2.1 EA2

Creates a mini-marshaller/unmarshaller that can process a TypeReference.

Returns:Bridge<T>

null if the specified reference is not given to JAXBRIContext#newInstance.

Since

2.0 EA1

Generates the episode file that represents the binding known to this JAXBContext, so that XJC can later do separate compilation.

Episode file is really just a JAXB customization file, except that currently we use the RI-specific SCD to refer to schema components.

Parameters

output:Result

This receives the generated episode file.

Since

2.1

Overrides jakarta.xml.bind.JAXBContext.generateSchema.

Generates the schema documents from the model.

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.

Parameters

outputResolver:SchemaOutputResolver

this object controls the output to which schemas will be sent.

Annotations

@Override

Exceptions

IOException:

if SchemaOutputResolver throws an IOException.

Gets the parameterization of the given base type.

For example, given the following

interface Foo<T> extends List<List<T>> {}
interface Bar extends Foo<String> {}

getBaseClass( Bar, List ) = List<List<String>
getBaseClass( Bar, Foo  ) = Foo<String>
getBaseClass( Foo<? extends Number>, Collection ) = Collection<List<? extends Number>>
getBaseClass( ArrayList<? extends BigInteger>, List ) = List<? extends BigInteger>

Parameters

type:Type

The type that derives from baseType

baseType:Class<T>

The class whose parameterization we are interested in.

Returns:Type

The use of baseType in type. or null if the type is not assignable to the base type.

Annotations

@Nullable

Since

2.0 FCS

Gets the build information of the JAXB runtime.

Returns:String

may be null, if the runtime is loaded by a class loader that doesn't support the access to the manifest informatino.

Annotations

@NotNull

If the given object is bound to an element in XML by JAXB, returns the element name.

Returns:QName

null if the object is not bound to an element.

Annotations

@Nullable

Exceptions

JAXBException:

if the object is not known to this context.

Since

2.0 EA1

Allows to retrieve the element name based on Class.

Annotations

@Nullable

Since

2.1.10

Gets a 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.

Parameters

<B>

type of the wrapper bean

<V>

type of the property of the bean

Returns:RawAccessor<B, V>

always return non-null valid accessor object.

Exceptions

JAXBException:

if the specified wrapper bean is not bound by JAXB, or if it doesn't have an element property of the given name.

Since

2.0 EA1

Gets the namespace URIs statically known to this 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.

Returns:List<String>

always non-null.

Annotations

@NotNull

Since

2.0 EA2

Allows you to access the runtime model information of the JAXB XML/Java binding.

This is useful for doing a deeper integration with the JAXB RI. For more information about the model, see https://jaxb2-reflection.dev.java.net/

Since

2.1.10

Returns the name of the XML Type bound to the specified Java type.

Parameters

tr:TypeReference

must not be null. This must be one of the TypeReferences specified in the JAXBRIContext#newInstance method.

Returns:QName

null if the referenced type is an anonymous and therefore doesn't have a name.

Exceptions

IllegalArgumentException:

if the parameter is null or not a part of the TypeReferences specified in the JAXBRIContext#newInstance method.

Returns true if this context includes a class that has XmlAttachmentRef.

Since

2.1

Computes a Java class name from a local name.

This method faithfully implements the name mangling rule as specified in the JAXB spec.

Returns:String

Typically, this method returns "NameLikeThis".

Annotations

@NotNull

Computes a Java class name from a local name.

This method faithfully implements the name mangling rule as specified in the JAXB spec. This method works like mangleNameToClassName(String) except that it looks for "getClass" and returns something else.

Returns:String

Typically, this method returns "NameLikeThis".

Annotations

@NotNull

Computes a Java identifier from a local name.

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.

Returns:String

Typically, this method returns "nameLikeThis".

Annotations

@NotNull

Creates a new .

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.

Parameters

classes:Class<T>[]

Classes to be bound. See JAXBContext#newInstance(Class[]) for the meaning.

typeRefs:Collection<TypeReference>

See TYPE_REFERENCES for the meaning of this parameter. Can be null.

subclassReplacements:Map<Class<T>, Class<T>>

See SUBCLASS_REPLACEMENTS for the meaning of this parameter. Can be null.

defaultNamespaceRemap:String

See DEFAULT_NAMESPACE_REMAP for the meaning of this parameter. Can be null (and should be null for ordinary use of JAXB.)

c14nSupport:boolean

See CANONICALIZATION_SUPPORT for the meaning of this parameter.

ar:RuntimeAnnotationReader

See ANNOTATION_READER for the meaning of this parameter. Can be null.

Since

JAXB 2.1 EA2

Creates a new .

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.

Parameters

classes:Class<T>[]

Classes to be bound. See JAXBContext#newInstance(Class[]) for the meaning.

typeRefs:Collection<TypeReference>

See TYPE_REFERENCES for the meaning of this parameter. Can be null.

subclassReplacements:Map<Class<T>, Class<T>>

See SUBCLASS_REPLACEMENTS for the meaning of this parameter. Can be null.

defaultNamespaceRemap:String

See DEFAULT_NAMESPACE_REMAP for the meaning of this parameter. Can be null (and should be null for ordinary use of JAXB.)

c14nSupport:boolean

See CANONICALIZATION_SUPPORT for the meaning of this parameter.

ar:RuntimeAnnotationReader

See ANNOTATION_READER for the meaning of this parameter. Can be null.

xmlAccessorFactorySupport:boolean

See XMLACCESSORFACTORY_SUPPORT for the meaning of this parameter.

allNillable:boolean

See TREAT_EVERYTHING_NILLABLE for the meaning of this parameter.

retainPropertyInfo:boolean

See RETAIN_REFERENCE_TO_INFO for the meaning of this parameter.

supressAccessorWarnings:boolean

See SUPRESS_ACCESSOR_WARNINGS for the meaning of this parameter.