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

Package org.mule.metadata.persistence

Class NullObjectTypeReferenceHandler

java.lang.Object

org.mule.metadata.persistence.NullObjectTypeReferenceHandler

All Implemented Interfaces:

ObjectTypeReferenceHandler

public final class NullObjectTypeReferenceHandler
extends Object
implements ObjectTypeReferenceHandler

A null object implementation of ObjectTypeReferenceHandler which handles no reference. Take into account that according to the contract defined in ObjectTypeReferenceHandler, each time any of these methods return Optional.empty() the invoker has the responsibility to resolve the type somehow else.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
NullObjectTypeReferenceHandler()

Method Summary

Modifier and Type	Method	Description
Optional<TypeBuilder>	readReference(String typeId)	Returns a TypeBuilder referenced by the given typeId.
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

NullObjectTypeReferenceHandler

public NullObjectTypeReferenceHandler()

Method Detail

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()

shouldWriteReference

public boolean shouldWriteReference(ObjectType type)

Description copied from interface: ObjectTypeReferenceHandler

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.

readReference

public Optional<TypeBuilder> readReference(String typeId)

Returns a TypeBuilder referenced by the given typeId. If the reference cannot be handled or points to an unknown type it returns Optional.empty()

Specified by:

readReference in interface ObjectTypeReferenceHandler

Parameters:

typeId - a type id

Returns:

an Optional TypeBuilder