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

Package org.mule.metadata.persistence

Class DefaultObjectTypeReferenceHandler

java.lang.Object

org.mule.metadata.persistence.DefaultObjectTypeReferenceHandler

All Implemented Interfaces:

ObjectTypeReferenceHandler

public class DefaultObjectTypeReferenceHandler
extends Object
implements ObjectTypeReferenceHandler

Implementation of ObjectTypeReferenceHandler which handles references by looking for the MetadataTypeConstants.REF_FLAG prefix.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
DefaultObjectTypeReferenceHandler(SerializationContext serializationContext)	Creates a new instance

Method Summary

Modifier and Type	Method	Description
Optional<TypeBuilder>	readReference(String typeReference)	If typeReference has the MetadataTypeConstants.REF_FLAG then it returns the type registered on the serializationContext under such key.
boolean	shouldWriteReference(ObjectType type)	Given an ObjectType retrieves if should be written as a reference or not.
Optional<String>	writeReference(ObjectType type, com.google.gson.stream.JsonWriter writer)	Uses the writer to write a reference to the given type.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultObjectTypeReferenceHandler

public DefaultObjectTypeReferenceHandler(SerializationContext serializationContext)

Creates a new instance

Parameters:

serializationContext - a SerializationContext to keep track of the references

Method Detail

readReference

public Optional<TypeBuilder> readReference(String typeReference)

If typeReference has the MetadataTypeConstants.REF_FLAG then it returns the type registered on the serializationContext under such key.

Specified by:

readReference in interface ObjectTypeReferenceHandler

Parameters:

typeReference - a reference

Returns:

an Optional TypeBuilder

shouldWriteReference

public boolean shouldWriteReference(ObjectType type)

Given an ObjectType retrieves if should be written as a reference or not.

Default implementation returns `true` to maintain backwards compatibility.

Specified by:

shouldWriteReference in interface ObjectTypeReferenceHandler

Parameters:

type - the type to write

Returns:

whether the type should be written or not.

writeReference

public Optional<String> writeReference(ObjectType type,
                                       com.google.gson.stream.JsonWriter writer)

Uses the writer to write a reference to the given type.

This method returns the written reference, so that it can be used as an id to deserialize. However, some implementations might be unable to handle some specific types, which is why the reference might be Optional.empty().

In such case, it's the invoker responsibility to either attempt using a different implementation of this contract or to just treat the type explicitly instead of through a reference.

Specified by:

writeReference in interface ObjectTypeReferenceHandler

Parameters:

type - the type to write

writer - a JsonWriter

Returns:

the reference that was written or Optional.empty()