com.squareup.square.internal.OptionalNullable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of square Show documentation

Java client library for the Square API

There is a newer version: 41.2.0.20241017


package com.squareup.square.internal;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;

/**
 * Class to encapsulate fields which are Optional as well as Nullable. It also
 * provides helper methods to create OptionalNullable generic type, and to
 * extract value from it.
 * @param  Type of the encapsulated field.
 */
public class OptionalNullable {

    /**
     * Private store for encapsulated object's value.
     */
    private T value;

    private OptionalNullable(T value) {
        this.value = value;
    }

    /**
     * Converts this OptionalNullable into string format.
     * @return String representation of this class
     */
    @Override
    public String toString() {
        return "" + value;
    }

    /**
     * Creates an OptionalNullable instance with the provided value.
     * @param    Type of the provided object.
     * @param value Value of the provided object.
     * @return {@link OptionalNullable} instance encapsulating given value.
     */
    public static  OptionalNullable of(T value) {
        return new OptionalNullable(value);
    }

    /**
     * Extracts the encapsulated value from the given OptionalNullable.
     * @param               Type of the expected value.
     * @param optionalNullable OptionalNullable instance to get value.
     * @return Value of the extracted field.
     */
    public static  T getFrom(OptionalNullable optionalNullable) {
        return (optionalNullable == null) ? null : optionalNullable.value;
    }

    /**
     * JsonSerializer for the {@link OptionalNullable} instance. It is used to
     * Serialize an {@link OptionalNullable} as its encapsulated object.
     */
    public static class Serializer extends JsonSerializer> {
        @Override
        public void serialize(OptionalNullable