org.mule.runtime.ast.internal.serialization

Class ArtifactAstSerializerMetadataSerializer

java.lang.Object

org.mule.runtime.ast.internal.serialization.ArtifactAstSerializerMetadataSerializer

public class ArtifactAstSerializerMetadataSerializer
extends Object

This class deals with the adding/reading into/from an input stream the metadata associated to ArtifactAst serialization. This metadata is generated during the artifact's serialization and must be added to the resulting InputStream so that it can be then read in order to use the correct deserializing implementation when deserializing.

The metadata is added to the stream in the form of a header string in the first line of the InputStream. This header string is composed by the serializer's id and the version, delimited by a pound sign (#). The max allowed length of the header string is as determined by the MAX_HEADER_LINE_LENGTH constant.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELIMITER
static char	END_HEADER_DELIMITER

Constructor Summary

Constructors

Constructor and Description
ArtifactAstSerializerMetadataSerializer()

Method Summary

Modifier and Type	Method and Description
InputStream	addArtifactAstSerializerMetadataToInputStream(InputStream inputStream, ArtifactAstSerializerMetadata artifactAstSerializerMetadata) This method serializes the ArtifactAstSerializerMetadata into a header string and adds it as a first line to the provided serialized ArtifactAst which should be an InputStream
ArtifactAstSerializerMetadata	readArtifactAstSerializerMetadataFromInputStream(InputStream inputStream) This method reads the metadata from an InputStream by reading the first line which should be a header string in a serialized ArtifactAst).

Methods inherited from class java.lang.Object

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

Field Detail

END_HEADER_DELIMITER

public static final char END_HEADER_DELIMITER

See Also:

Constant Field Values

DELIMITER

public static final String DELIMITER

See Also:

Constant Field Values

Constructor Detail

ArtifactAstSerializerMetadataSerializer

public ArtifactAstSerializerMetadataSerializer()

Method Detail

readArtifactAstSerializerMetadataFromInputStream

public ArtifactAstSerializerMetadata readArtifactAstSerializerMetadataFromInputStream(InputStream inputStream)
                                                                               throws IOException

This method reads the metadata from an InputStream by reading the first line which should be a header string in a serialized ArtifactAst). This header string is composed by the serializer's id and the version, delimited by a pound sign (#).

The max allowed length of the header string is as determined by the MAX_HEADER_LINE_LENGTH constant. Since this method only read the first line, the rest of the input stream will be still available for consumption.

Parameters:

inputStream - a serialized ArtifactAst generated by an ArtifactAstSerializer

Returns:

a ArtifactAstSerializerMetadata instance containing the id and version indicated in the input stream's metadata.

Throws:

IOException - If an I/O error occurs

addArtifactAstSerializerMetadataToInputStream

public InputStream addArtifactAstSerializerMetadataToInputStream(InputStream inputStream,
                                                                 ArtifactAstSerializerMetadata artifactAstSerializerMetadata)

This method serializes the ArtifactAstSerializerMetadata into a header string and adds it as a first line to the provided serialized ArtifactAst which should be an InputStream

Parameters:

inputStream - the serialized ArtifactAst created with an ArtifactAstSerializer

artifactAstSerializerMetadata - the ArtifactAstSerializerMetadata that represents the information associated with the ArtifactAstSerializer used to generate the given InputStream

Returns:

an InputStream whose first line is the serialized ArtifactAstSerializerMetadata and is followed by the contents of the given serialized ArtifactAst's InputStream