Module org.mule.runtime.metadata.model.persistence

Package org.mule.metadata.persistence

Class AbstractJsonMetadataTypeWriter

java.lang.Object

org.mule.metadata.persistence.AbstractJsonMetadataTypeWriter

All Implemented Interfaces:

TypeWriter, MetadataTypeWriter

Direct Known Subclasses:

JsonMetadataTypeWriter, ReducedJsonMetadataTypeWriter

public abstract class AbstractJsonMetadataTypeWriter
extends Object
implements TypeWriter, MetadataTypeWriter

Base class for MetadataTypeWriters implementations that serialize MetadataType objects into a readable and processable JSON file, that can be deserialize again into a MetadataType using a SerializedMetadataTypeLoader.

This class is not Thread-safe.

Since:

1.2.0, 1.1.7

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	prettyPrint
protected Stack<MetadataType>	typeStack
protected com.google.gson.stream.JsonWriter	writer

Constructor Summary

Constructors

Constructor	Description
AbstractJsonMetadataTypeWriter()

Method Summary

Modifier and Type	Method	Description
AbstractJsonMetadataTypeWriter	setPrettyPrint(boolean prettyPrint)	Changes the value of PrettyPrint property of the ReducedJsonMetadataTypeWriter.
String	toString(MetadataType structure)	Given a MetadataType, serializes it into JSON format, the result of the serialization will be the output of the operation as a String
protected abstract void	write(MetadataType type)	Given a MetadataType, serializes it into a JSON format.
void	write(MetadataType metadataType, com.google.gson.stream.JsonWriter writer)	Given a MetadataType, serializes it into a JSON format, the result of the serialization will be written by the {@param writer}.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

writer

protected com.google.gson.stream.JsonWriter writer

typeStack

protected Stack<MetadataType> typeStack

prettyPrint

protected boolean prettyPrint

Constructor Detail

AbstractJsonMetadataTypeWriter

public AbstractJsonMetadataTypeWriter()

Method Detail

toString

public String toString(MetadataType structure)

Given a MetadataType, serializes it into JSON format, the result of the serialization will be the output of the operation as a String

Specified by:

toString in interface TypeWriter

Parameters:

structure - MetadataType to doSerialize.

Throws:

MetadataSerializingException - in any error case

write

public void write(MetadataType metadataType,
                  com.google.gson.stream.JsonWriter writer)
           throws IOException

Given a MetadataType, serializes it into a JSON format, the result of the serialization will be written by the {@param writer}.

Specified by:

write in interface MetadataTypeWriter

Parameters:

metadataType - MetadataType to doSerialize.

writer - JsonWriter which will be used to write the serialized MetadataType

Throws:

IOException - if any error occurred when writing the JSON file.

write

protected abstract void write(MetadataType type)
                       throws IOException

Given a MetadataType, serializes it into a JSON format.

It is expected that a proper writer is already set to this object.

Parameters:

type - MetadataType to doSerialize.

Throws:

IOException - if any error occurred when writing the JSON file.

setPrettyPrint

public AbstractJsonMetadataTypeWriter setPrettyPrint(boolean prettyPrint)

Changes the value of PrettyPrint property of the ReducedJsonMetadataTypeWriter. If it is enabled, when toString(MetadataType) is executed the output String will be printed in a human readable format, otherwise, by default, the JSON will be printed in a compact and more performable format.

Parameters:

prettyPrint - boolean value indicating if the writer should pretty print the JSON

Returns:

the configured TypeWriter instance