JAXBDataBinding (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- org.apache.cxf.databinding.AbstractDataBinding
- - org.apache.cxf.databinding.AbstractInterceptorProvidingDataBinding
  - - org.apache.cxf.jaxb.JAXBDataBinding

All Implemented Interfaces:: DataBinding, WrapperCapableDatabinding, InterceptorProvider

public class JAXBDataBinding
extends AbstractInterceptorProvidingDataBinding
implements WrapperCapableDatabinding, InterceptorProvider

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JAXB_SCAN_PACKAGES`
`static String`	`MTOM_THRESHOLD`
`static String`	`READER_VALIDATION_EVENT_HANDLER`
`static String`	`SCHEMA_RESOURCE`
`static String`	`SET_VALIDATION_EVENT_HANDLER`
`static String`	`UNWRAP_JAXB_ELEMENT`
`static String`	`USE_JAXB_BRIDGE`
`static String`	`VALIDATION_EVENT_HANDLER`
`static String`	`WRITER_VALIDATION_EVENT_HANDLER`

Fields inherited from class org.apache.cxf.databinding.AbstractInterceptorProvidingDataBinding
inFaultInterceptors, inInterceptors, outFaultInterceptors, outInterceptors

Fields inherited from class org.apache.cxf.databinding.AbstractDataBinding
mtomEnabled, mtomThreshold

Constructor Summary

Constructors
Constructor and Description
`JAXBDataBinding()`
`JAXBDataBinding(boolean q)`
`JAXBDataBinding(boolean qualified, Map<String,Object> props)`
`JAXBDataBinding(Class<?>... classes)`
`JAXBDataBinding(JAXBContext context)`

Method Summary

Methods
Modifier and Type	Method and Description
`JAXBContext`	`createJAXBContext(Set<Class<?>> classes)`
`JAXBContext`	`createJAXBContext(Set<Class<?>> classes, String defaultNs)`
`JAXBContextCache.CachedContextAndSchemas`	`createJAXBContextAndSchemas(Set<Class<?>> classes, String defaultNs)`
`<T> DataReader<T>`	`createReader(Class<T> c)`
`WrapperHelper`	`createWrapperHelper(Class<?> wrapperType, QName wrapperName, List<String> partNames, List<String> elTypeNames, List<Class<?>> partClasses)`
`<T> DataWriter<T>`	`createWriter(Class<T> c)`
`List<XmlAdapter<?,?>>`	`getConfiguredXmlAdapters()`
`JAXBContext`	`getContext()`
`Set<Class<?>>`	`getContextClasses()`
`Map<String,Object>`	`getContextProperties()` Return a map of properties.
`Class<?>[]`	`getExtraClass()`
`Marshaller.Listener`	`getMarshallerListener()` Returns the Marshaller.Listener that will be registered on the Marshallers
`Map<String,Object>`	`getMarshallerProperties()` Return a map of properties.
`Class<?>[]`	`getSupportedReaderFormats()`
`Class<?>[]`	`getSupportedWriterFormats()`
`Unmarshaller.Listener`	`getUnmarshallerListener()` Returns the Unmarshaller.Listener that will be registered on the Unmarshallers
`Map<String,Object>`	`getUnmarshallerProperties()` Return a map of properties.
`ValidationEventHandler`	`getValidationEventHandler()`
`void`	`initialize(Service service)` Initialize the service info (i.e.
`boolean`	`isUnwrapJAXBElement()`
`void`	`setConfiguredXmlAdapters(List<XmlAdapter<?,?>> adpters)`
`void`	`setContext(JAXBContext ctx)`
`void`	`setContextProperties(Map<String,Object> contextProperties)` Set a map of JAXB context properties.
`void`	`setExtraClass(Class<?>[] userExtraClass)`
`void`	`setMarshallerListener(Marshaller.Listener marshallerListener)` Sets the Marshaller.Listener that will be registered on the Marshallers
`void`	`setMarshallerProperties(Map<String,Object> marshallerProperties)` Set a map of JAXB marshaller properties.
`void`	`setUnmarshallerListener(Unmarshaller.Listener unmarshallerListener)` Sets the Unmarshaller.Listener that will be registered on the Unmarshallers
`void`	`setUnmarshallerProperties(Map<String,Object> unmarshallerProperties)` Set a map of JAXB unmarshaller properties.
`void`	`setUnwrapJAXBElement(boolean unwrapJAXBElement)`
`void`	`setValidationEventHandler(ValidationEventHandler validationEventHandler)`

Methods inherited from class org.apache.cxf.databinding.AbstractInterceptorProvidingDataBinding
getInFaultInterceptors, getInInterceptors, getOutFaultInterceptors, getOutInterceptors

Methods inherited from class org.apache.cxf.databinding.AbstractDataBinding
addSchemaDocument, addSchemaDocument, checkNamespaceMap, getBus, getContextualNamespaceMap, getDeclaredNamespaceMappings, getMtomThreshold, getNamespaceMap, getSchemas, isMtomEnabled, setBus, setContextualNamespaceMap, setMtomEnabled, setMtomThreshold, setNamespaceMap, setSchemas, updateSchemaLocation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.cxf.interceptor.InterceptorProvider
getInFaultInterceptors, getInInterceptors, getOutFaultInterceptors, getOutInterceptors

Field Detail
- READER_VALIDATION_EVENT_HANDLER
```
public static final String READER_VALIDATION_EVENT_HANDLER
```
  See Also:
  Constant Field Values
- VALIDATION_EVENT_HANDLER
```
public static final String VALIDATION_EVENT_HANDLER
```
  See Also:
  Constant Field Values
- SET_VALIDATION_EVENT_HANDLER
```
public static final String SET_VALIDATION_EVENT_HANDLER
```
  See Also:
  Constant Field Values
- WRITER_VALIDATION_EVENT_HANDLER
```
public static final String WRITER_VALIDATION_EVENT_HANDLER
```
  See Also:
  Constant Field Values
- SCHEMA_RESOURCE
```
public static final String SCHEMA_RESOURCE
```
  See Also:
  Constant Field Values
- MTOM_THRESHOLD
```
public static final String MTOM_THRESHOLD
```
  See Also:
  Constant Field Values
- UNWRAP_JAXB_ELEMENT
```
public static final String UNWRAP_JAXB_ELEMENT
```
  See Also:
  Constant Field Values
- USE_JAXB_BRIDGE
```
public static final String USE_JAXB_BRIDGE
```
  See Also:
  Constant Field Values
- JAXB_SCAN_PACKAGES
```
public static final String JAXB_SCAN_PACKAGES
```
  See Also:
  Constant Field Values

Constructor Detail

JAXBDataBinding
```
public JAXBDataBinding()
```

JAXBDataBinding
```
public JAXBDataBinding(boolean q)
```

JAXBDataBinding

public JAXBDataBinding(Class<?>... classes)
                throws JAXBException

Throws:: JAXBException

JAXBDataBinding

public JAXBDataBinding(boolean qualified,
               Map<String,Object> props)
                throws JAXBException

Throws:: JAXBException

JAXBDataBinding

public JAXBDataBinding(JAXBContext context)

Method Detail
- getContext
```
public JAXBContext getContext()
```
- setContext
```
public final void setContext(JAXBContext ctx)
```
- createWriter
```
public <T> DataWriter<T> createWriter(Class<T> c)
```
  Specified by:
  
  createWriter in interface DataBinding
- getSupportedWriterFormats
```
public Class<?>[] getSupportedWriterFormats()
```
  Specified by:
  
  getSupportedWriterFormats in interface DataBinding
- createReader
```
public <T> DataReader<T> createReader(Class<T> c)
```
  Specified by:
  
  createReader in interface DataBinding
- getSupportedReaderFormats
```
public Class<?>[] getSupportedReaderFormats()
```
  Specified by:
  
  getSupportedReaderFormats in interface DataBinding
- initialize
```
public void initialize(Service service)
```
  Description copied from interface: DataBinding
  
  Initialize the service info (i.e. type & element names, Schemas) with information from the databinding.
  
  Specified by:
  
  initialize in interface DataBinding
- setExtraClass
```
public void setExtraClass(Class<?>[] userExtraClass)
```
- getExtraClass
```
public Class<?>[] getExtraClass()
```
- createJAXBContext
```
public JAXBContext createJAXBContext(Set<Class<?>> classes)
                              throws JAXBException
```
  Throws:
  
  JAXBException
- createJAXBContext
```
public JAXBContext createJAXBContext(Set<Class<?>> classes,
                            String defaultNs)
                              throws JAXBException
```
  Throws:
  
  JAXBException
- createJAXBContextAndSchemas
```
public JAXBContextCache.CachedContextAndSchemas createJAXBContextAndSchemas(Set<Class<?>> classes,
                                                                   String defaultNs)
                                                                     throws JAXBException
```
  Throws:
  
  JAXBException
- getContextClasses
```
public Set<Class<?>> getContextClasses()
```
- getContextProperties
```
public Map<String,Object> getContextProperties()
```
  Return a map of properties. These properties are passed to JAXBContext.newInstance when this object creates a context.
  
  Returns:
  the map of JAXB context properties.
- setContextProperties
```
public void setContextProperties(Map<String,Object> contextProperties)
```
  Set a map of JAXB context properties. These properties are passed to JAXBContext.newInstance when this object creates a context. Note that if you create a JAXB context elsewhere, you will not respect these properties unless you handle it manually.
  
  Parameters:
  contextProperties - map of properties.
- getConfiguredXmlAdapters
```
public List<XmlAdapter<?,?>> getConfiguredXmlAdapters()
```
- setConfiguredXmlAdapters
```
public void setConfiguredXmlAdapters(List<XmlAdapter<?,?>> adpters)
```
- getMarshallerProperties
```
public Map<String,Object> getMarshallerProperties()
```
  Return a map of properties. These properties are set into the JAXB Marshaller (via Marshaller.setProperty(...) when the marshaller is created.
  
  Returns:
  the map of JAXB marshaller properties.
- setMarshallerProperties
```
public void setMarshallerProperties(Map<String,Object> marshallerProperties)
```
  Set a map of JAXB marshaller properties. These properties are set into the JAXB Marshaller (via Marshaller.setProperty(...) when the marshaller is created.
  
  Parameters:
  marshallerProperties - map of properties.
- getUnmarshallerProperties
```
public Map<String,Object> getUnmarshallerProperties()
```
  Return a map of properties. These properties are set into the JAXB Unmarshaller (via Unmarshaller.setProperty(...) when the unmarshaller is created.
  
  Returns:
  the map of JAXB unmarshaller properties.
- setUnmarshallerProperties
```
public void setUnmarshallerProperties(Map<String,Object> unmarshallerProperties)
```
  Set a map of JAXB unmarshaller properties. These properties are set into the JAXB Unmarshaller (via Unmarshaller.setProperty(...) when the unmarshaller is created.
  
  Parameters:
  unmarshallerProperties - map of properties.
- getUnmarshallerListener
```
public Unmarshaller.Listener getUnmarshallerListener()
```
  Returns the Unmarshaller.Listener that will be registered on the Unmarshallers
  
  Returns:
- setUnmarshallerListener
```
public void setUnmarshallerListener(Unmarshaller.Listener unmarshallerListener)
```
  Sets the Unmarshaller.Listener that will be registered on the Unmarshallers
  
  Parameters:
  unmarshallerListener -
- getMarshallerListener
```
public Marshaller.Listener getMarshallerListener()
```
  Returns the Marshaller.Listener that will be registered on the Marshallers
  
  Returns:
- setMarshallerListener
```
public void setMarshallerListener(Marshaller.Listener marshallerListener)
```
  Sets the Marshaller.Listener that will be registered on the Marshallers
  
  Parameters:
  marshallerListener -
- getValidationEventHandler
```
public ValidationEventHandler getValidationEventHandler()
```
- setValidationEventHandler
```
public void setValidationEventHandler(ValidationEventHandler validationEventHandler)
```
- isUnwrapJAXBElement
```
public boolean isUnwrapJAXBElement()
```
- setUnwrapJAXBElement
```
public void setUnwrapJAXBElement(boolean unwrapJAXBElement)
```
- createWrapperHelper
```
public WrapperHelper createWrapperHelper(Class<?> wrapperType,
                                QName wrapperName,
                                List<String> partNames,
                                List<String> elTypeNames,
                                List<Class<?>> partClasses)
```
  Specified by:
  
  createWrapperHelper in interface WrapperCapableDatabinding

Class JAXBDataBinding

Field Summary

Fields inherited from class org.apache.cxf.databinding.AbstractInterceptorProvidingDataBinding

Fields inherited from class org.apache.cxf.databinding.AbstractDataBinding

Constructor Summary

Method Summary

Methods inherited from class org.apache.cxf.databinding.AbstractInterceptorProvidingDataBinding

Methods inherited from class org.apache.cxf.databinding.AbstractDataBinding

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.cxf.interceptor.InterceptorProvider

Field Detail

READER_VALIDATION_EVENT_HANDLER

VALIDATION_EVENT_HANDLER

SET_VALIDATION_EVENT_HANDLER

WRITER_VALIDATION_EVENT_HANDLER

SCHEMA_RESOURCE

MTOM_THRESHOLD

UNWRAP_JAXB_ELEMENT

USE_JAXB_BRIDGE

JAXB_SCAN_PACKAGES

Constructor Detail

JAXBDataBinding

JAXBDataBinding

JAXBDataBinding

JAXBDataBinding

JAXBDataBinding

Method Detail

getContext

setContext

createWriter

getSupportedWriterFormats

createReader

getSupportedReaderFormats

initialize

setExtraClass

getExtraClass

createJAXBContext

createJAXBContext

createJAXBContextAndSchemas

getContextClasses

getContextProperties

setContextProperties

getConfiguredXmlAdapters

setConfiguredXmlAdapters

getMarshallerProperties

setMarshallerProperties

getUnmarshallerProperties

setUnmarshallerProperties

getUnmarshallerListener

setUnmarshallerListener

getMarshallerListener

setMarshallerListener

getValidationEventHandler

setValidationEventHandler

isUnwrapJAXBElement

setUnwrapJAXBElement

createWrapperHelper