JodaBeanSer (Joda-Beans 2.2 API)

java.lang.Object
- org.joda.beans.ser.JodaBeanSer

```
public final class JodaBeanSer
extends java.lang.Object
```
Provides the ability for a Joda-Bean to be serialized.
Serialization of Joda-Beans uses the information in the beans to optimize the size of the data output.

Field Summary

Fields
Modifier and Type Field Description

static JodaBeanSer COMPACT
Obtains the singleton compact instance.

static JodaBeanSer PRETTY
Obtains the singleton pretty-printing instance.

Fields
Modifier and Type	Field	Description
`static JodaBeanSer`	`COMPACT`	Obtains the singleton compact instance.
`static JodaBeanSer`	`PRETTY`	Obtains the singleton pretty-printing instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`JodaBeanBinReader`	`binReader()`	Creates a binary reader.
`JodaBeanBinWriter`	`binWriter()`	Creates a binary writer.
`org.joda.convert.StringConvert`	`getConverter()`	Gets the string converter.
`SerDeserializers`	`getDeserializers()`	Gets the deserializers.
`java.lang.String`	`getIndent()`	Gets the pretty print indent.
`SerIteratorFactory`	`getIteratorFactory()`	Gets the iterator factory.
`java.lang.String`	`getNewLine()`	Gets the new line string.
`boolean`	`isIncludeDerived()`	Gets the include derived flag.
`boolean`	`isShortTypes()`	Gets whether to use short types.
`JodaBeanJsonReader`	`jsonReader()`	Creates a JSON reader.
`JodaBeanJsonWriter`	`jsonWriter()`	Creates a JSON writer.
`JodaBeanSimpleJsonReader`	`simpleJsonReader()`	Creates a simple JSON reader.
`JodaBeanSimpleJsonWriter`	`simpleJsonWriter()`	Creates a simple JSON writer.
`JodaBeanSimpleMapReader`	`simpleMapReader()`	Creates a simple in-memory `Map` reader.
`JodaBeanSimpleMapWriter`	`simpleMapWriter()`	Creates a simple in-memory `Map` writer.
`java.lang.String`	`toString()`
`JodaBeanSer`	`withConverter(org.joda.convert.StringConvert converter)`	Returns a copy of this serializer with the specified string converter.
`JodaBeanSer`	`withDeserializers(SerDeserializers deserializers)`	Returns a copy of this serializer with the specified deserializers.
`JodaBeanSer`	`withIncludeDerived(boolean includeDerived)`	Returns a copy of this serializer with the specified include derived flag.
`JodaBeanSer`	`withIndent(java.lang.String indent)`	Returns a copy of this serializer with the specified pretty print indent.
`JodaBeanSer`	`withIteratorFactory(SerIteratorFactory iteratorFactory)`	Returns a copy of this serializer with the specified iterator factory.
`JodaBeanSer`	`withNewLine(java.lang.String newLine)`	Returns a copy of this serializer with the specified pretty print new line.
`JodaBeanSer`	`withShortTypes(boolean shortTypes)`	Returns a copy of this serializer with the short types flag set.
`JodaBeanXmlReader`	`xmlReader()`	Creates an XML reader.
`JodaBeanXmlWriter`	`xmlWriter()`	Creates an XML writer.

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

- Field Detail
  - COMPACT
```
public static final JodaBeanSer COMPACT
```
    Obtains the singleton compact instance.
  - PRETTY
```
public static final JodaBeanSer PRETTY
```
    Obtains the singleton pretty-printing instance.
- Method Detail
  - getIndent
```
public java.lang.String getIndent()
```
    Gets the pretty print indent.
    
    Returns:
    
    the indent, not null
  - withIndent
```
public JodaBeanSer withIndent(java.lang.String indent)
```
    Returns a copy of this serializer with the specified pretty print indent.
    
    Parameters:
    
    indent - the indent, not null
    
    Returns:
    
    a copy of this object with the indent changed, not null
  - getNewLine
```
public java.lang.String getNewLine()
```
    Gets the new line string.
    
    Returns:
    
    the newLine, not null
  - withNewLine
```
public JodaBeanSer withNewLine(java.lang.String newLine)
```
    Returns a copy of this serializer with the specified pretty print new line.
    
    Parameters:
    
    newLine - the new line, not null
    
    Returns:
    
    a copy of this object with the new line changed, not null
  - getConverter
```
public org.joda.convert.StringConvert getConverter()
```
    Gets the string converter.
    The default converter can be modified.
    
    Returns:
    
    the converter, not null
  - withConverter
```
public JodaBeanSer withConverter(org.joda.convert.StringConvert converter)
```
    Returns a copy of this serializer with the specified string converter.
    The default converter can be modified.
    
    Parameters:
    
    converter - the converter, not null
    
    Returns:
    
    a copy of this object with the converter changed, not null
  - getIteratorFactory
```
public SerIteratorFactory getIteratorFactory()
```
    Gets the iterator factory.
    
    Returns:
    
    the iterator factory, not null
  - withIteratorFactory
```
public JodaBeanSer withIteratorFactory(SerIteratorFactory iteratorFactory)
```
    Returns a copy of this serializer with the specified iterator factory.
    
    Parameters:
    
    iteratorFactory - the iterator factory, not null
    
    Returns:
    
    a copy of this object with the iterator factory changed, not null
  - isShortTypes
```
public boolean isShortTypes()
```
    Gets whether to use short types.
    
    Returns:
    
    the short types flag, not null
  - withShortTypes
```
public JodaBeanSer withShortTypes(boolean shortTypes)
```
    Returns a copy of this serializer with the short types flag set.
    
    Parameters:
    
    shortTypes - whether to use short types, not null
    
    Returns:
    
    a copy of this object with the short types flag changed, not null
  - getDeserializers
```
public SerDeserializers getDeserializers()
```
    Gets the deserializers.
    The default deserializers can be modified.
    
    Returns:
    
    the converter, not null
  - withDeserializers
```
public JodaBeanSer withDeserializers(SerDeserializers deserializers)
```
    Returns a copy of this serializer with the specified deserializers.
    The default deserializers can be modified.
    This can be used to select a more lenient mode of parsing, see SerDeserializers.LENIENT.
    
    Parameters:
    
    deserializers - the deserializers, not null
    
    Returns:
    
    a copy of this object with the converter changed, not null
  - isIncludeDerived
```
public boolean isIncludeDerived()
```
    Gets the include derived flag.
    The default deserializers can be modified.
    
    Returns:
    
    the converter, not null
  - withIncludeDerived
```
public JodaBeanSer withIncludeDerived(boolean includeDerived)
```
    Returns a copy of this serializer with the specified include derived flag.
    The default deserializers can be modified.
    This is used to set the output to include derived properties.
    
    Parameters:
    
    includeDerived - whether to include derived properties on output
    
    Returns:
    
    a copy of this object with the converter changed, not null
  - binWriter
```
public JodaBeanBinWriter binWriter()
```
    Creates a binary writer.
    A new instance of the writer must be created for each message.
    
    Returns:
    
    the binary writer, not null
  - binReader
```
public JodaBeanBinReader binReader()
```
    Creates a binary reader.
    A new instance of the reader must be created for each message.
    
    Returns:
    
    the binary reader, not null
  - xmlWriter
```
public JodaBeanXmlWriter xmlWriter()
```
    Creates an XML writer.
    A new instance of the writer must be created for each message.
    
    Returns:
    
    the XML writer, not null
  - xmlReader
```
public JodaBeanXmlReader xmlReader()
```
    Creates an XML reader.
    A new instance of the reader must be created for each message.
    
    Returns:
    
    the XML reader, not null
  - jsonWriter
```
public JodaBeanJsonWriter jsonWriter()
```
    Creates a JSON writer.
    A new instance of the writer must be created for each message.
    
    Returns:
    
    the JSON writer, not null
  - jsonReader
```
public JodaBeanJsonReader jsonReader()
```
    Creates a JSON reader.
    A new instance of the reader must be created for each message.
    
    Returns:
    
    the JSON reader, not null
  - simpleJsonWriter
```
public JodaBeanSimpleJsonWriter simpleJsonWriter()
```
    Creates a simple JSON writer.
    A new instance of the writer must be created for each message. The simple writer omits all metadata. It is suitable for simple beans as often found in data-transfer protocols.
    Not all beans can be used with the simple JSON writer as no type information is written. If a bean has subclasses, or the declared type of a property or collection is Object, then the JSON will not round trip. Where the type cannot be determined, the reader will return Boolean, Integer, Double, String, ArrayList or string keyed HashMap. Maps must have keys that can be written as a string.
    
    Returns:
    
    the simple JSON writer, not null
  - simpleJsonReader
```
public JodaBeanSimpleJsonReader simpleJsonReader()
```
    Creates a simple JSON reader.
    A new instance of the reader must be created for each message. The simple reader is designed to operate with the simple writer. It will not operate well with the output of jsonWriter().
    
    Returns:
    
    the simple JSON reader, not null
  - simpleMapWriter
```
public JodaBeanSimpleMapWriter simpleMapWriter()
```
    Creates a simple in-memory Map writer.
    A new instance of the writer must be created for each message.
    
    Returns:
    
    the simple map writer, not null
  - simpleMapReader
```
public JodaBeanSimpleMapReader simpleMapReader()
```
    Creates a simple in-memory Map reader.
    A new instance of the reader must be created for each message.
    
    Returns:
    
    the simple map reader, not null
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class JodaBeanSer

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMPACT

PRETTY

Method Detail

getIndent

withIndent

getNewLine

withNewLine

getConverter

withConverter

getIteratorFactory

withIteratorFactory

isShortTypes

withShortTypes

getDeserializers

withDeserializers

isIncludeDerived

withIncludeDerived

binWriter

binReader

xmlWriter

xmlReader

jsonWriter

jsonReader

simpleJsonWriter

simpleJsonReader

simpleMapWriter

simpleMapReader

toString