JaxbContextBuilder (common-xml 1.0.2 API)

```
public interface JaxbContextBuilder
```
The jaxb context builder.

Author:

Christian Bremer

Field Summary

Fields
Modifier and Type	Field and Description
`static BiFunction<Class<?>,Map<String,JaxbContextData>,Boolean>`	`CAN_MARSHAL_ALL` The can marshal all function.
`static BiFunction<Class<?>,Map<String,JaxbContextData>,Boolean>`	`CAN_MARSHAL_ONLY_PREDEFINED_DATA` The can marshal only predefined data function.
`static BiFunction<Class<?>,Map<String,JaxbContextData>,Boolean>`	`CAN_UNMARSHAL_ALL` The can unmarshal all function.
`static BiFunction<Class<?>,Map<String,JaxbContextData>,Boolean>`	`CAN_UNMARSHAL_ONLY_PREDEFINED_DATA` The can unmarshal only predefined data function.
`static JaxbDependenciesResolver`	`DEFAULT_DEPENDENCIES_RESOLVER` The default dependencies resolver implementation.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`JaxbContextBuilder`	`add(JaxbContextData data)` Add jaxb context meta data to the jaxb context builder.
`default JaxbContextBuilder`	`add(String contextPath)` Add the given context path (package names which are separated by colon) to the jaxb context builder.
`default JaxbContextBuilder`	`addAll(Iterable<? extends JaxbContextData> data)` Add all jaxb context meta data to the jaxb context builder.
`default JaxbContextBuilder`	`addAll(Iterator<? extends JaxbContextData> data)` Add all jaxb context meta data to the jaxb context builder.
`static JaxbContextBuilder`	`builder()` Creates a new jaxb context builder.
`default JaxbContextWrapper`	`buildJaxbContext()` Build default jaxb context that is defined by the added meta data.
`JaxbContextWrapper`	`buildJaxbContext(Object value)` Build jaxb context for the given object (POJO) or for the given class or array of classes with the specified dependencies resolver.
`default Marshaller`	`buildMarshaller()` Build marshaller with the context which is defined by the added meta data.
`Marshaller`	`buildMarshaller(Object value)` Build marshaller for the given object (POJO) or for the given class or array of classes with the specified dependencies resolver.
`default Schema`	`buildSchema()` Build schema of the default jaxb context (defined by the added meta data).
`Schema`	`buildSchema(Object value)` Build schema of the specified value (POJO), a single class or an array of classes.
`default Unmarshaller`	`buildUnmarshaller()` Build unmarshaller with the context which is defined by the added meta data.
`Unmarshaller`	`buildUnmarshaller(Object value)` Build unmarshaller for the given object (POJO) or for the given class or array of classes with the specified dependencies resolver.
`boolean`	`canMarshal(Class<?> clazz)` Determines whether the marshaller can encode an object of the given class into xml.
`boolean`	`canUnmarshal(Class<?> clazz)` Determines whether the unmarshaller can decode xml into an object of the given class.
`JaxbContextBuilder`	`copy()` Copy jaxb context builder.
`JaxbContextBuilder`	`initJaxbContext()` Inits default jaxb context.
`default JaxbContextBuilder`	`process(JaxbContextDataProvider dataProvider)` Process the jaxb context meta data provider and add it's data to the jaxb context builder.
`default JaxbContextBuilder`	`processAll(Iterable<? extends JaxbContextDataProvider> dataProviders)` Process the jaxb context meta data providers and add their data to the jaxb context builder.
`default JaxbContextBuilder`	`processAll(Iterator<? extends JaxbContextDataProvider> dataProviders)` Process the jaxb context meta data providers and add their data to the jaxb context builder.
`JaxbContextBuilder`	`withAttachmentMarshaller(AttachmentMarshaller attachmentMarshaller)` Set attachment marshaller.
`JaxbContextBuilder`	`withAttachmentUnmarshaller(AttachmentUnmarshaller attachmentUnmarshaller)` Set attachment unmarshaller.
`JaxbContextBuilder`	`withCanMarshal(BiFunction<Class<?>,Map<String,JaxbContextData>,Boolean> function)` Sets a function of the builder to determine whether the builder is responsible for the given class.
`JaxbContextBuilder`	`withCanUnmarshal(BiFunction<Class<?>,Map<String,JaxbContextData>,Boolean> function)` Sets a function of the builder to determine whether the builder is responsible for the given class.
`JaxbContextBuilder`	`withContextClassLoader(ClassLoader classLoader)` Specifies the class loader to use.
`JaxbContextBuilder`	`withDependenciesResolver(JaxbDependenciesResolver resolver)` Specifies the dependencies resolver to use.
`JaxbContextBuilder`	`withFormattedOutput(boolean formattedOutput)` Specify whether the xml output should be formatted or not.
`JaxbContextBuilder`	`withSchemaBuilder(SchemaBuilder schemaBuilder)` Specifies the schema builder to generate the schema.
`JaxbContextBuilder`	`withSchemaMode(SchemaMode schemaMode)` Specifies whether to add a schema to the marshaller or unmarshaller.
`JaxbContextBuilder`	`withValidationEventHandler(ValidationEventHandler validationEventHandler)` Set validation event handler of marshaller and unmarshaller.
`JaxbContextBuilder`	`withXmlAdapters(Collection<? extends XmlAdapter<?,?>> xmlAdapters)` Sets xml adapters of marshaller and unmarshaller.

- Field Detail
  - DEFAULT_DEPENDENCIES_RESOLVER
```
static final JaxbDependenciesResolver DEFAULT_DEPENDENCIES_RESOLVER
```
    The default dependencies resolver implementation.
    
    See Also:
    
    withDependenciesResolver(JaxbDependenciesResolver)
  - CAN_MARSHAL_ALL
```
static final BiFunction<Class<?>,Map<String,JaxbContextData>,Boolean> CAN_MARSHAL_ALL
```
    The can marshal all function. If this function is set, the builder can marshal all objects which are annotated with XmlRootElement. This is the default behaviour.
    
    See Also:
    
    withCanMarshal(BiFunction)
  - CAN_UNMARSHAL_ALL
```
static final BiFunction<Class<?>,Map<String,JaxbContextData>,Boolean> CAN_UNMARSHAL_ALL
```
    The can unmarshal all function. If this function is set, the builder can unmarshal all objects which are annotated with XmlRootElement. This is the default behaviour.
    
    See Also:
    
    withCanUnmarshal(BiFunction)
  - CAN_MARSHAL_ONLY_PREDEFINED_DATA
```
static final BiFunction<Class<?>,Map<String,JaxbContextData>,Boolean> CAN_MARSHAL_ONLY_PREDEFINED_DATA
```
    The can marshal only predefined data function. If this function is set, the builder can marshal only objects which were added previously to the builder.
    
    See Also:
    
    withCanMarshal(BiFunction)
  - CAN_UNMARSHAL_ONLY_PREDEFINED_DATA
```
static final BiFunction<Class<?>,Map<String,JaxbContextData>,Boolean> CAN_UNMARSHAL_ONLY_PREDEFINED_DATA
```
    The can unmarshal only predefined data function. If this function is set, the builder can unmarshal only objects which were added previously to the builder.
    
    See Also:
    
    withCanUnmarshal(BiFunction)
- Method Detail
  - builder
```
static JaxbContextBuilder builder()
```
    Creates a new jaxb context builder.
    
    Returns:
    
    the jaxb context builder
  - copy
```
JaxbContextBuilder copy()
```
    Copy jaxb context builder.
    
    Returns:
    
    the jaxb context builder
  - withCanMarshal
```
JaxbContextBuilder withCanMarshal(BiFunction<Class<?>,Map<String,JaxbContextData>,Boolean> function)
```
    Sets a function of the builder to determine whether the builder is responsible for the given class. The first parameter of the function is the class, the second is a map with meta data, which were previously added to the builder). The key of the map is a package name.
    
    Parameters:
    
    function - the function
    
    Returns:
    
    the jaxb context builder
    
    See Also:
    
    canMarshal(Class)
  - withCanUnmarshal
```
JaxbContextBuilder withCanUnmarshal(BiFunction<Class<?>,Map<String,JaxbContextData>,Boolean> function)
```
    Sets a function of the builder to determine whether the builder is responsible for the given class. The first parameter of the function is the class, the second is a map with meta data, which were previously added to the builder). The key of the map is a package name.
    
    Parameters:
    
    function - the function
    
    Returns:
    
    the jaxb context builder
    
    See Also:
    
    canUnmarshal(Class)
  - withSchemaMode
```
JaxbContextBuilder withSchemaMode(SchemaMode schemaMode)
```
    Specifies whether to add a schema to the marshaller or unmarshaller. The default is to add never a schema to the marshaller or unmarshaller.
    
    Parameters:
    
    schemaMode - the schema mode
    
    Returns:
    
    the jaxb context builder
    
    See Also:
    
    SchemaMode.NEVER, SchemaMode.ALWAYS, SchemaMode.MARSHAL, SchemaMode.UNMARSHAL, SchemaMode.EXTERNAL_XSD
  - withSchemaBuilder
```
JaxbContextBuilder withSchemaBuilder(SchemaBuilder schemaBuilder)
```
    Specifies the schema builder to generate the schema. The default is the default schema builder implementation (see SchemaBuilder.builder()).
    
    Parameters:
    
    schemaBuilder - the schema builder
    
    Returns:
    
    the jaxb context builder
  - withDependenciesResolver
```
JaxbContextBuilder withDependenciesResolver(JaxbDependenciesResolver resolver)
```
    Specifies the dependencies resolver to use. The default jaxb context builder will use a default implementation.
    To turn off dependency resolving set null here.
    
    Parameters:
    
    resolver - the resolver
    
    Returns:
    
    the jaxb context builder
  - withContextClassLoader
```
JaxbContextBuilder withContextClassLoader(ClassLoader classLoader)
```
    Specifies the class loader to use.
    
    Parameters:
    
    classLoader - the class loader
    
    Returns:
    
    the jaxb context builder
  - withFormattedOutput
```
JaxbContextBuilder withFormattedOutput(boolean formattedOutput)
```
    Specify whether the xml output should be formatted or not.
    
    Parameters:
    
    formattedOutput - the formatted output
    
    Returns:
    
    the jaxb context builder
  - withXmlAdapters
```
JaxbContextBuilder withXmlAdapters(Collection<? extends XmlAdapter<?,?>> xmlAdapters)
```
    Sets xml adapters of marshaller and unmarshaller.
    
    Parameters:
    
    xmlAdapters - the xml adapters
    
    Returns:
    
    the jaxb context builder
  - withAttachmentMarshaller
```
JaxbContextBuilder withAttachmentMarshaller(AttachmentMarshaller attachmentMarshaller)
```
    Set attachment marshaller.
    
    Parameters:
    
    attachmentMarshaller - the attachment marshaller
    
    Returns:
    
    the jaxb context builder
  - withAttachmentUnmarshaller
```
JaxbContextBuilder withAttachmentUnmarshaller(AttachmentUnmarshaller attachmentUnmarshaller)
```
    Set attachment unmarshaller.
    
    Parameters:
    
    attachmentUnmarshaller - the attachment unmarshaller
    
    Returns:
    
    the jaxb context builder
  - withValidationEventHandler
```
JaxbContextBuilder withValidationEventHandler(ValidationEventHandler validationEventHandler)
```
    Set validation event handler of marshaller and unmarshaller.
    
    Parameters:
    
    validationEventHandler - the validation event handler
    
    Returns:
    
    the jaxb context builder
  - add
```
default JaxbContextBuilder add(String contextPath)
```
    Add the given context path (package names which are separated by colon) to the jaxb context builder. This is the same as JAXBContext.newInstance(String).
    
    Parameters:
    
    contextPath - the context path (package names which are separated by colon)
    
    Returns:
    
    the jaxb context builder
  - add
```
JaxbContextBuilder add(JaxbContextData data)
```
    Add jaxb context meta data to the jaxb context builder.
    
    Parameters:
    
    data - the data
    
    Returns:
    
    the jaxb context builder
  - addAll
```
default JaxbContextBuilder addAll(Iterable<? extends JaxbContextData> data)
```
    Add all jaxb context meta data to the jaxb context builder.
    
    Parameters:
    
    data - the data
    
    Returns:
    
    the jaxb context builder
  - addAll
```
default JaxbContextBuilder addAll(Iterator<? extends JaxbContextData> data)
```
    Add all jaxb context meta data to the jaxb context builder.
    
    Parameters:
    
    data - the data
    
    Returns:
    
    the jaxb context builder
  - process
```
default JaxbContextBuilder process(JaxbContextDataProvider dataProvider)
```
    Process the jaxb context meta data provider and add it's data to the jaxb context builder.
    
    Parameters:
    
    dataProvider - the data provider
    
    Returns:
    
    the jaxb context builder
  - processAll
```
default JaxbContextBuilder processAll(Iterable<? extends JaxbContextDataProvider> dataProviders)
```
    Process the jaxb context meta data providers and add their data to the jaxb context builder.
    
    Parameters:
    
    dataProviders - the data providers
    
    Returns:
    
    the jaxb context builder
  - processAll
```
default JaxbContextBuilder processAll(Iterator<? extends JaxbContextDataProvider> dataProviders)
```
    Process the jaxb context meta data providers and add their data to the jaxb context builder.
    
    Parameters:
    
    dataProviders - the data providers
    
    Returns:
    
    the jaxb context builder
  - canUnmarshal
```
boolean canUnmarshal(Class<?> clazz)
```
    Determines whether the unmarshaller can decode xml into an object of the given class. The function that is set by withCanUnmarshal(BiFunction) will be used.
    
    Parameters:
    
    clazz - the class
    
    Returns:
    
    true if the unmarshaller can decode xml into an object of the given class, otherwise false
  - canMarshal
```
boolean canMarshal(Class<?> clazz)
```
    Determines whether the marshaller can encode an object of the given class into xml. The function that is set by withCanMarshal(BiFunction) will be used.
    
    Parameters:
    
    clazz - the class
    
    Returns:
    
    true if the marshaller can decode an object of the given class into xml, otherwise false
  - buildUnmarshaller
```
default Unmarshaller buildUnmarshaller()
```
    Build unmarshaller with the context which is defined by the added meta data.
    
    Returns:
    
    the unmarshaller
  - buildUnmarshaller
```
Unmarshaller buildUnmarshaller(Object value)
```
    Build unmarshaller for the given object (POJO) or for the given class or array of classes with the specified dependencies resolver. If dependency resolving is turned off, an unmarshaller of the default context (defined by the added meta data) will be returned or one that is created with JAXBContext.newInstance(Class[]).
    
    Parameters:
    
    value - the value (POJO) that should be processed by the unmarshaller or a single class or an array of classes
    
    Returns:
    
    the unmarshaller
    
    See Also:
    
    JaxbDependenciesResolver
  - buildMarshaller
```
default Marshaller buildMarshaller()
```
    Build marshaller with the context which is defined by the added meta data.
    
    Returns:
    
    the marshaller
  - buildMarshaller
```
Marshaller buildMarshaller(Object value)
```
    Build marshaller for the given object (POJO) or for the given class or array of classes with the specified dependencies resolver. If dependency resolving is turned off, a marshaller of the default context (defined by the added meta data) will be returned or one that is created with JAXBContext.newInstance(Class[]).
    
    Parameters:
    
    value - the value (POJO) that should be processed by the marshaller or a single class or an array of classes
    
    Returns:
    
    the marshaller
    
    See Also:
    
    JaxbDependenciesResolver
  - initJaxbContext
```
JaxbContextBuilder initJaxbContext()
```
    Inits default jaxb context. Otherwise the jaxb context will be created at first usage.
    
    Returns:
    
    the jaxb context builder
  - buildJaxbContext
```
default JaxbContextWrapper buildJaxbContext()
```
    Build default jaxb context that is defined by the added meta data.
    
    Returns:
    
    the jaxb context wrapper
  - buildJaxbContext
```
JaxbContextWrapper buildJaxbContext(Object value)
```
    Build jaxb context for the given object (POJO) or for the given class or array of classes with the specified dependencies resolver. If dependency resolving is turned off, the default jaxb context (defined by the added meta data) will be returned or a jaxb context will be created with JAXBContext.newInstance(Class[]).
    
    Parameters:
    
    value - the value (POJO) that should be processed by the jaxb context or a single class or an array of classes
    
    Returns:
    
    the jaxb context
  - buildSchema
```
default Schema buildSchema()
```
    Build schema of the default jaxb context (defined by the added meta data).
    
    Returns:
    
    the schema
  - buildSchema
```
Schema buildSchema(Object value)
```
    Build schema of the specified value (POJO), a single class or an array of classes.
    
    Parameters:
    
    value - the value (POJO), a single class or an array of classes for which the schema should be created
    
    Returns:
    
    the schema

Interface JaxbContextBuilder

Field Summary

Method Summary

Field Detail

DEFAULT_DEPENDENCIES_RESOLVER

CAN_MARSHAL_ALL

CAN_UNMARSHAL_ALL

CAN_MARSHAL_ONLY_PREDEFINED_DATA

CAN_UNMARSHAL_ONLY_PREDEFINED_DATA

Method Detail

builder

copy

withCanMarshal

withCanUnmarshal

withSchemaMode

withSchemaBuilder

withDependenciesResolver

withContextClassLoader

withFormattedOutput

withXmlAdapters

withAttachmentMarshaller

withAttachmentUnmarshaller

withValidationEventHandler

add

add

addAll

addAll

process

processAll

processAll

canUnmarshal

canMarshal

buildUnmarshaller

buildUnmarshaller

buildMarshaller

buildMarshaller

initJaxbContext

buildJaxbContext

buildJaxbContext

buildSchema

buildSchema