com.aldebaran.qi.serialization

Class OptionalConverter

java.lang.Object

com.aldebaran.qi.serialization.OptionalConverter

All Implemented Interfaces:

QiSerializer.Converter

public class OptionalConverter
extends Object
implements QiSerializer.Converter

Converter for Optional objects.

This class is responsible for adapting Optional objects of a custom value type from and to Optional objects of a type that the native layer can handle.

Since:

3.1.0

See Also:

QiSerializer, QiSerializer.Converter, Optional

Constructor Summary

Constructors

Constructor and Description
OptionalConverter()

Method Summary

Modifier and Type	Method and Description
boolean	canDeserialize(Object object, Type targetType)
boolean	canSerialize(Object object)
Optional<?>	deserialize(QiSerializer serializer, Object object, Type targetType) Creates an object of optional type targetType adapted from an optional object object.
Optional<?>	serialize(QiSerializer serializer, Object object) Creates an optional object adapted from an optional object object.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionalConverter

public OptionalConverter()

Method Detail

canSerialize

public boolean canSerialize(Object object)

Specified by:

canSerialize in interface QiSerializer.Converter

Returns:

True if object is an instance of Optional.

serialize

public Optional<?> serialize(QiSerializer serializer,
                             Object object)
                      throws QiConversionException

Creates an optional object adapted from an optional object object. The logic is:

• If the optional has a value, recursively adapts the value by calling QiSerializer.serialize(Object) on it.
• Otherwise, just returns an empty generic Optional.

Specified by:

serialize in interface QiSerializer.Converter

Throws:

QiConversionException -

• If !canSerialize(object), then the cause of the exception is an IllegalArgumentException.
• If the serialization of the value throws an exception.

See Also:

canSerialize(Object), Optional, Optional.map(Function)

canDeserialize

public boolean canDeserialize(Object object,
                              Type targetType)

Specified by:

canDeserialize in interface QiSerializer.Converter

Returns:

True if object is an instance of Optional and targetType is a specialization of Optional.

deserialize

public Optional<?> deserialize(QiSerializer serializer,
                               Object object,
                               Type targetType)
                        throws QiConversionException

Creates an object of optional type targetType adapted from an optional object object. The logic is:

• If the optional has a value, recursively adapts the value by calling QiSerializer.deserialize(Object, Type) on it with the optional value type as the target type.
• Otherwise, just returns an empty generic Optional.

Specified by:

deserialize in interface QiSerializer.Converter

Throws:

QiConversionException -

• If !canDeserialize(object), then the cause of the exception is a IllegalArgumentException.
• If the serialization of the value throws an exception.

See Also:

canDeserialize(Object, Type), Optional, Optional.map(Function)