JAXBBuilderDefaultSettings (ph-jaxb 10.1.5 API)

java.lang.Object
- com.helger.jaxb.builder.JAXBBuilderDefaultSettings

```
@ThreadSafe
public final class JAXBBuilderDefaultSettings
extends Object
```
A class containing some default settings for the various JAXB builders. Each new instance of JAXBReaderBuilder, JAXBValidationBuilder and JAXBWriterBuilder use the settings in this class as the defaults.
Changes made in this class only effects instances that are created afterwards. Existing instances are never changed.

Author:

Philip Helger

Field Summary

Fields
Modifier and Type Field and Description

static Charset DEFAULT_CHARSET

static boolean DEFAULT_FORMATTED_OUTPUT

static boolean DEFAULT_USE_CONTEXT_CACHE

Fields
Modifier and Type	Field and Description
`static Charset`	`DEFAULT_CHARSET`
`static boolean`	`DEFAULT_FORMATTED_OUTPUT`
`static boolean`	`DEFAULT_USE_CONTEXT_CACHE`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Charset`	`getDefaultCharset()`
`static String`	`getDefaultIndentString()`
`static NamespaceContext`	`getDefaultNamespaceContext()`
`static String`	`getDefaultNoNamespaceSchemaLocation()`
`static String`	`getDefaultSchemaLocation()`
`static ValidationEventHandler`	`getDefaultValidationEventHandler()`
`static boolean`	`isDefaultFormattedOutput()`
`static boolean`	`isDefaultUseContextCache()`
`static void`	`setDefaultCharset(Charset aCharset)` Set the default charset to be used for writing JAXB objects.
`static void`	`setDefaultFormattedOutput(boolean bFormattedOutput)` Enable or disable the formatting of the output.
`static void`	`setDefaultIndentString(String sIndentString)` Set the default indent string to be used for writing JAXB objects.
`static void`	`setDefaultNamespaceContext(NamespaceContext aNamespaceContext)` Set the default namespace context (prefix to namespace URL mapping) to be used.
`static void`	`setDefaultNoNamespaceSchemaLocation(String sNoNamespaceSchemaLocation)` Set the no namespace schema location to be used for writing JAXB objects.
`static void`	`setDefaultSchemaLocation(String sSchemaLocation)` Set the schema location to be used for writing JAXB objects.
`static void`	`setDefaultUseContextCache(boolean bUseContextCache)` Enable or disable the usage of the JAXBContext cache.
`static void`	`setDefaultValidationEventHandler(ValidationEventHandler aEventHandler)` Set a global event handler that should be passed to all read/write actions.

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

- Field Detail
  - DEFAULT_USE_CONTEXT_CACHE
```
public static final boolean DEFAULT_USE_CONTEXT_CACHE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FORMATTED_OUTPUT
```
public static final boolean DEFAULT_FORMATTED_OUTPUT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CHARSET
```
public static final Charset DEFAULT_CHARSET
```
- Method Detail
  - setDefaultUseContextCache
```
public static void setDefaultUseContextCache(boolean bUseContextCache)
```
    Enable or disable the usage of the JAXBContext cache. For performance reasons it is recommended to enable it. By default it is enabled.
    
    Parameters:
    
    bUseContextCache - true to enable it, false to disable it.
  - isDefaultUseContextCache
```
public static boolean isDefaultUseContextCache()
```
    Returns:
    
    true if the JAXBContext cache should be used. Default is true.
  - setDefaultValidationEventHandler
```
public static void setDefaultValidationEventHandler(@Nullable
                                                    ValidationEventHandler aEventHandler)
```
    Set a global event handler that should be passed to all read/write actions. If no global validation handler is defined, a default logging event handler is used.
    
    Parameters:
    
    aEventHandler - The new default event handler. May be null to indicate, that the default handler should be used.
  - getDefaultValidationEventHandler
```
@Nullable
public static ValidationEventHandler getDefaultValidationEventHandler()
```
    Returns:
    
    The current default validation event handler. May be null to indicate that no global validation event handler is defined, and the default validation handler is used.
  - setDefaultNamespaceContext
```
public static void setDefaultNamespaceContext(@Nullable
                                              NamespaceContext aNamespaceContext)
```
    Set the default namespace context (prefix to namespace URL mapping) to be used.
    
    Parameters:
    
    aNamespaceContext - The namespace context to be used by default. May be null.
  - getDefaultNamespaceContext
```
@Nullable
public static NamespaceContext getDefaultNamespaceContext()
```
    Returns:
    
    The special JAXB namespace context to be used. null by default.
  - setDefaultFormattedOutput
```
public static void setDefaultFormattedOutput(boolean bFormattedOutput)
```
    Enable or disable the formatting of the output.
    
    Parameters:
    
    bFormattedOutput - true to enable it, false to disable it.
  - isDefaultFormattedOutput
```
public static boolean isDefaultFormattedOutput()
```
    Returns:
    
    true if the JAXB output should be formatted. Only for writers. Default is false. The JDK implementation does not format by default.
  - setDefaultCharset
```
public static void setDefaultCharset(@Nullable
                                     Charset aCharset)
```
    Set the default charset to be used for writing JAXB objects.
    
    Parameters:
    
    aCharset - The charset to be used by default. May be null.
  - getDefaultCharset
```
@Nullable
public static Charset getDefaultCharset()
```
    Returns:
    
    The special JAXB Charset to be used for writing. null by default. The JDK implementation uses UTF-8 by default.
  - setDefaultIndentString
```
public static void setDefaultIndentString(@Nullable
                                          String sIndentString)
```
    Set the default indent string to be used for writing JAXB objects.
    
    Parameters:
    
    sIndentString - The indent string to be used by default. May be null.
  - getDefaultIndentString
```
@Nullable
public static String getDefaultIndentString()
```
    Returns:
    
    The JAXB indentation string to be used for writing. null by default. Only used when formatted output is used. The JDK implementation uses 4 spaces by default.
  - setDefaultSchemaLocation
```
public static void setDefaultSchemaLocation(@Nullable
                                            String sSchemaLocation)
```
    Set the schema location to be used for writing JAXB objects.
    
    Parameters:
    
    sSchemaLocation - The schema location to be used by default. May be null.
    
    Since:
    
    8.6.0
  - getDefaultSchemaLocation
```
@Nullable
public static String getDefaultSchemaLocation()
```
    Returns:
    
    The JAXB schema location to be used for writing. null by default.
    
    Since:
    
    8.6.0
  - setDefaultNoNamespaceSchemaLocation
```
public static void setDefaultNoNamespaceSchemaLocation(@Nullable
                                                       String sNoNamespaceSchemaLocation)
```
    Set the no namespace schema location to be used for writing JAXB objects.
    
    Parameters:
    
    sNoNamespaceSchemaLocation - The no namespace schema location to be used by default. May be null.
    
    Since:
    
    9.0.0
  - getDefaultNoNamespaceSchemaLocation
```
@Nullable
public static String getDefaultNoNamespaceSchemaLocation()
```
    Returns:
    
    The JAXB no namespace schema location to be used for writing. null by default.
    
    Since:
    
    9.0.0

Class JAXBBuilderDefaultSettings

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_USE_CONTEXT_CACHE

DEFAULT_FORMATTED_OUTPUT

DEFAULT_CHARSET

Method Detail

setDefaultUseContextCache

isDefaultUseContextCache

setDefaultValidationEventHandler

getDefaultValidationEventHandler

setDefaultNamespaceContext

getDefaultNamespaceContext

setDefaultFormattedOutput

isDefaultFormattedOutput

setDefaultCharset

getDefaultCharset

setDefaultIndentString

getDefaultIndentString

setDefaultSchemaLocation

getDefaultSchemaLocation

setDefaultNoNamespaceSchemaLocation

getDefaultNoNamespaceSchemaLocation