org.joda.beans.ser.JodaBeanSer Maven / Gradle / Ivy
/*
* Copyright 2001-present Stephen Colebourne
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.joda.beans.ser;
import org.joda.beans.JodaBeanUtils;
import org.joda.beans.MetaProperty;
import org.joda.beans.ser.bin.JodaBeanBinReader;
import org.joda.beans.ser.bin.JodaBeanBinWriter;
import org.joda.beans.ser.json.JodaBeanJsonReader;
import org.joda.beans.ser.json.JodaBeanJsonWriter;
import org.joda.beans.ser.json.JodaBeanSimpleJsonReader;
import org.joda.beans.ser.json.JodaBeanSimpleJsonWriter;
import org.joda.beans.ser.map.JodaBeanSimpleMapReader;
import org.joda.beans.ser.map.JodaBeanSimpleMapWriter;
import org.joda.beans.ser.xml.JodaBeanXmlReader;
import org.joda.beans.ser.xml.JodaBeanXmlWriter;
import org.joda.convert.StringConvert;
/**
* 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.
*/
public final class JodaBeanSer {
/**
* Obtains the singleton compact instance.
*/
public static final JodaBeanSer COMPACT = new JodaBeanSer("", "", StringConvert.create(),
SerIteratorFactory.INSTANCE, true, SerDeserializers.INSTANCE, false);
/**
* Obtains the singleton pretty-printing instance.
*/
public static final JodaBeanSer PRETTY = new JodaBeanSer(" ", "\n", StringConvert.create(),
SerIteratorFactory.INSTANCE, true, SerDeserializers.INSTANCE, false);
/**
* The indent to use.
*/
private final String indent;
/**
* The new line to use.
*/
private final String newLine;
/**
* The string converter to use.
*/
private final StringConvert converter;
/**
* The iterator factory to use.
*/
private final SerIteratorFactory iteratorFactory;
/**
* Whether to use short types.
*/
private final boolean shortTypes;
/**
* The deserializers.
*/
private final SerDeserializers deserializers;
/**
* Whether to include derived properties.
*/
private final boolean includeDerived;
/**
* Creates an instance.
*
* @param indent the indent, not null
* @param newLine the new line, not null
* @param converter the converter, not null
* @param iteratorFactory the iterator factory, not null
* @param shortTypes whether to use short types
* @param deserializers the deserializers to use, not null
*/
private JodaBeanSer(String indent, String newLine, StringConvert converter,
SerIteratorFactory iteratorFactory, boolean shortTypes, SerDeserializers deserializers, boolean includeDerived) {
this.indent = indent;
this.newLine = newLine;
this.converter = converter;
this.iteratorFactory = iteratorFactory;
this.shortTypes = shortTypes;
this.deserializers = deserializers;
this.includeDerived = includeDerived;
}
//-----------------------------------------------------------------------
/**
* Gets the pretty print indent.
*
* @return the indent, not null
*/
public String getIndent() {
return indent;
}
/**
* Returns a copy of this serializer with the specified pretty print indent.
*
* @param indent the indent, not null
* @return a copy of this object with the indent changed, not null
*/
public JodaBeanSer withIndent(String indent) {
JodaBeanUtils.notNull(indent, "indent");
return new JodaBeanSer(indent, newLine, converter, iteratorFactory, shortTypes, deserializers, includeDerived);
}
/**
* Gets the new line string.
*
* @return the newLine, not null
*/
public String getNewLine() {
return newLine;
}
/**
* Returns a copy of this serializer with the specified pretty print new line.
*
* @param newLine the new line, not null
* @return a copy of this object with the new line changed, not null
*/
public JodaBeanSer withNewLine(String newLine) {
JodaBeanUtils.notNull(newLine, "newLine");
return new JodaBeanSer(indent, newLine, converter, iteratorFactory, shortTypes, deserializers, includeDerived);
}
/**
* Gets the string converter.
*
* The default converter can be modified.
*
* @return the converter, not null
*/
public StringConvert getConverter() {
return converter;
}
/**
* Returns a copy of this serializer with the specified string converter.
*
* The default converter can be modified.
*
* @param converter the converter, not null
* @return a copy of this object with the converter changed, not null
*/
public JodaBeanSer withConverter(StringConvert converter) {
JodaBeanUtils.notNull(converter, "converter");
return new JodaBeanSer(indent, newLine, converter, iteratorFactory, shortTypes, deserializers, includeDerived);
}
/**
* Gets the iterator factory.
*
* @return the iterator factory, not null
*/
public SerIteratorFactory getIteratorFactory() {
return iteratorFactory;
}
/**
* Returns a copy of this serializer with the specified iterator factory.
*
* @param iteratorFactory the iterator factory, not null
* @return a copy of this object with the iterator factory changed, not null
*/
public JodaBeanSer withIteratorFactory(SerIteratorFactory iteratorFactory) {
JodaBeanUtils.notNull(iteratorFactory, "iteratorFactory");
return new JodaBeanSer(indent, newLine, converter, iteratorFactory, shortTypes, deserializers, includeDerived);
}
/**
* Gets whether to use short types.
*
* @return the short types flag, not null
*/
public boolean isShortTypes() {
return shortTypes;
}
/**
* Returns a copy of this serializer with the short types flag set.
*
* @param shortTypes whether to use short types, not null
* @return a copy of this object with the short types flag changed, not null
*/
public JodaBeanSer withShortTypes(boolean shortTypes) {
return new JodaBeanSer(indent, newLine, converter, iteratorFactory, shortTypes, deserializers, includeDerived);
}
/**
* Gets the deserializers.
*
* The default deserializers can be modified.
*
* @return the converter, not null
*/
public SerDeserializers getDeserializers() {
return 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 {@link SerDeserializers#LENIENT}.
*
* @param deserializers the deserializers, not null
* @return a copy of this object with the converter changed, not null
*/
public JodaBeanSer withDeserializers(SerDeserializers deserializers) {
JodaBeanUtils.notNull(deserializers, "deserializers");
return new JodaBeanSer(indent, newLine, converter, iteratorFactory, shortTypes, deserializers, includeDerived);
}
//-----------------------------------------------------------------------
/**
* Gets the include derived flag.
*
* The default deserializers can be modified.
*
* @return the converter, not null
*/
public boolean isIncludeDerived() {
return 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.
*
* @param includeDerived whether to include derived properties on output
* @return a copy of this object with the converter changed, not null
*/
public JodaBeanSer withIncludeDerived(boolean includeDerived) {
return new JodaBeanSer(indent, newLine, converter, iteratorFactory, shortTypes, deserializers, includeDerived);
}
/**
* Checks if the property is serialized.
*
* @param prop the property to check
* @return true if the property is seialized
*/
public boolean isSerialized(MetaProperty prop) {
return prop.style().isSerializable() || (prop.style().isDerived() && includeDerived);
}
//-----------------------------------------------------------------------
/**
* Creates a reader that determines the file format and parses it.
*
* This parser can handle XML, JSON, simple JSON, binary and binary referencing formats.
*
* It is recommended, though not necessary, to create a new instance of the reader for each message.
*
* @return the smart reader, not null
*/
public JodaBeanSmartReader smartReader() {
return new JodaBeanSmartReader(this);
}
//-----------------------------------------------------------------------
/**
* Creates a binary writer using the standard format.
*
* It is recommended, though not necessary, to create a new instance of the writer for each message.
*
* @return the binary writer, not null
*/
public JodaBeanBinWriter binWriter() {
return new JodaBeanBinWriter(this, false);
}
/**
* Creates a binary writer using the referencing format that typically results in a smaller output.
*
* It is recommended, though not necessary, to create a new instance of the writer for each message.
*
* The writer only supports serializing ImmutableBean instances and will throw an exception
* if any non-immutable beans are encountered.
* It assumes that non-bean items present within the root bean are themselves immutable.
* Due to this immutability restriction it serializes references to values based on object equality,
* rather than based on reference equality. When the output is parsed it may be smaller in memory
* as any beans that were originally equal will be returned as pointers to the same instance.
*
* The reader {@link #binReader()} handles both the standard and referencing formats.
*
* @return the referencing binary writer, not null
*/
public JodaBeanBinWriter binWriterReferencing() {
return new JodaBeanBinWriter(this, true);
}
/**
* Creates a binary reader that handles both the standard and referencing binary formats.
*
* It is recommended, though not necessary, to create a new instance of the reader for each message.
*
* @return the binary reader, not null
*/
public JodaBeanBinReader binReader() {
return new JodaBeanBinReader(this);
}
//-----------------------------------------------------------------------
/**
* Creates an XML writer.
*
* A new instance of the writer must be created for each message.
*
* @return the XML writer, not null
*/
public JodaBeanXmlWriter xmlWriter() {
return new JodaBeanXmlWriter(this);
}
/**
* Creates an XML reader.
*
* A new instance of the reader must be created for each message.
*
* @return the XML reader, not null
*/
public JodaBeanXmlReader xmlReader() {
return new JodaBeanXmlReader(this);
}
//-----------------------------------------------------------------------
/**
* Creates a JSON writer.
*
* A new instance of the writer must be created for each message.
*
* @return the JSON writer, not null
*/
public JodaBeanJsonWriter jsonWriter() {
return new JodaBeanJsonWriter(this);
}
/**
* Creates a JSON reader.
*
* A new instance of the reader must be created for each message.
*
* @return the JSON reader, not null
*/
public JodaBeanJsonReader jsonReader() {
return new JodaBeanJsonReader(this);
}
//-----------------------------------------------------------------------
/**
* 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
* {@code Object}, then the JSON will not round trip. Where the type cannot be determined,
* the reader will return {@code Boolean}, {@code Integer}, {@code Double}, {@code String},
* {@code ArrayList} or string keyed {@code HashMap}.
* Maps must have keys that can be written as a string.
*
* @return the simple JSON writer, not null
*/
public JodaBeanSimpleJsonWriter simpleJsonWriter() {
return new JodaBeanSimpleJsonWriter(this);
}
/**
* 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 {@link #jsonWriter()}.
*
* @return the simple JSON reader, not null
*/
public JodaBeanSimpleJsonReader simpleJsonReader() {
return new JodaBeanSimpleJsonReader(this);
}
//-----------------------------------------------------------------------
/**
* Creates a simple in-memory {@code Map} writer.
*
* A new instance of the writer must be created for each message.
*
* @return the simple map writer, not null
*/
public JodaBeanSimpleMapWriter simpleMapWriter() {
return new JodaBeanSimpleMapWriter(this);
}
/**
* Creates a simple in-memory {@code Map} reader.
*
* A new instance of the reader must be created for each message.
*
* @return the simple map reader, not null
*/
public JodaBeanSimpleMapReader simpleMapReader() {
return new JodaBeanSimpleMapReader(this);
}
//-----------------------------------------------------------------------
@Override
public String toString() {
return getClass().getSimpleName();
}
}