Module org.mule.runtime.artifact.ast.serialization

Package org.mule.runtime.ast.api.serialization

Interface ArtifactAstDeserializer

All Known Subinterfaces:

InternalArtifactAstDeserializer

All Known Implementing Classes:

DefaultArtifactAstDeserializer, JsonArtifactAstDeserializer

@NoImplement
public interface ArtifactAstDeserializer

Defines a component capable of deserializing an InputStream created using an ArtifactAstSerializer into an ArtifactAst.

The content of the InputStream might have been generated in different ways, depending on the ArtifactAstSerializer used, each requiring a specific deserialization process to be determined by the implementation. If the deserializer cannot handle this input stream, an IllegalArgumentException will be thrown.

ExtensionModel related information must be provided by the client code. This means that in order to deserialize, such information is required and must be presented as an input of the deserialization method.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
ArtifactAst	deserialize(InputStream artifactAstInputStream, ExtensionModelResolver extensionModelResolver)	Given an InputStream created by serializing an ArtifactAst with an ArtifactAstSerializer and an ExtensionModelResolver able to provide the required ExtensionModels, this method deserializes the InputStream into an ArtifactAst.
ArtifactAst	deserialize(InputStream artifactAstInputStream, ExtensionModelResolver extensionModelResolver, ArtifactAst parent)	Given an InputStream created by serializing an ArtifactAst with an ArtifactAstSerializer and an ExtensionModelResolver able to provide the required ExtensionModels, this method deserializes the InputStream into an ArtifactAst.

Method Details

deserialize

ArtifactAst deserialize(InputStream artifactAstInputStream,
 ExtensionModelResolver extensionModelResolver)
                 throws IllegalArgumentException,
IOException

Given an InputStream created by serializing an ArtifactAst with an ArtifactAstSerializer and an ExtensionModelResolver able to provide the required ExtensionModels, this method deserializes the InputStream into an ArtifactAst.

Parameters:

artifactAstInputStream - the input stream generated by an ArtifactAstSerializer

extensionModelResolver - an ExtensionModelResolver able to provide the ExtensionModels required by this serialized ArtifactAst

Returns:

The artifact

Throws:

IllegalArgumentException - if this deserializer cannot perform a deserialization with the given InputStream and/or ExtensionModelResolver

IOException - if the input stream could not be read

deserialize

ArtifactAst deserialize(InputStream artifactAstInputStream,
 ExtensionModelResolver extensionModelResolver,
 ArtifactAst parent)
                 throws IllegalArgumentException,
IOException

Given an InputStream created by serializing an ArtifactAst with an ArtifactAstSerializer and an ExtensionModelResolver able to provide the required ExtensionModels, this method deserializes the InputStream into an ArtifactAst.

This method accepts a parent ArtifactAst as an argument. An ArtifactAst might have a parent that requires its own ExtensionModels in order to be enrich, and furthermore, might be the parent of multiple ArtifactAsts. That is why the parent needs to be resolved before its children passing it as a parameter with this method.

Parameters:

artifactAstInputStream - the input stream generated by an ArtifactAstSerializer

extensionModelResolver - an ExtensionModelResolver able to provide the ExtensionModels required by this serialized ArtifactAst

parent - the parent ArtifactAst to be set to the resulting deserialized ArtifactAst

Returns:

The artifact

Throws:

IllegalArgumentException - if this deserializer cannot perform a deserialization with the given InputStream and/or ExtensionModelResolver

IOException - if the input stream could not be read