com.paypal.sdk.models.CaptureStatus Maven / Gradle / Ivy

Go to download
/*
 * PaypalServerSDKLib
 *
 * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

package com.paypal.sdk.models;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.TreeMap;


/**
 * CaptureStatus to be used.
 */
public enum CaptureStatus {
    COMPLETED,

    DECLINED,

    PARTIALLY_REFUNDED,

    PENDING,

    REFUNDED,

    FAILED,

    /**
     * Unknown values will be mapped by this enum member
     */
    _UNKNOWN;


    private static TreeMap valueMap = new TreeMap<>();
    private String value;

    static {
        COMPLETED.value = "COMPLETED";
        DECLINED.value = "DECLINED";
        PARTIALLY_REFUNDED.value = "PARTIALLY_REFUNDED";
        PENDING.value = "PENDING";
        REFUNDED.value = "REFUNDED";
        FAILED.value = "FAILED";
        _UNKNOWN.value = null;

        valueMap.put("COMPLETED", COMPLETED);
        valueMap.put("DECLINED", DECLINED);
        valueMap.put("PARTIALLY_REFUNDED", PARTIALLY_REFUNDED);
        valueMap.put("PENDING", PENDING);
        valueMap.put("REFUNDED", REFUNDED);
        valueMap.put("FAILED", FAILED);
    }

    /**
     * Returns the enum member associated with the given string value.
     * @param toConvert String value to get enum member.
     * @return The enum member against the given string value.
     * @throws IOException when provided value is not mapped to any enum member.
     */
    @JsonCreator
    public static CaptureStatus constructFromString(String toConvert) throws IOException {
        CaptureStatus enumValue = fromString(toConvert);
        if (enumValue == null) {
            throw new IOException("Unable to create enum instance with value: " + toConvert);
        }
        return enumValue;
    }

    /**
     * Returns the enum member associated with the given string value.
     * @param toConvert String value to get enum member.
     * @return The enum member against the given string value.
     */
    public static CaptureStatus fromString(String toConvert) {
        if (!valueMap.containsKey(toConvert)) {
            return _UNKNOWN;
        }
        return valueMap.get(toConvert);
    }

    /**
     * Returns the string value associated with the enum member.
     * @return The string value against enum member.
     */
    @JsonValue
    public String value() {
        return value;
    }
        
    /**
     * Get string representation of this enum.
     */
    @Override
    public String toString() {
        if (value == null) {
            return null;
        }
        return value.toString();
    }

    /**
     * Convert list of CaptureStatus values to list of string values.
     * @param toConvert The list of CaptureStatus values to convert.
     * @return List of representative string values.
     */
    public static List toValue(List toConvert) {
        if (toConvert == null) {
            return null;
        }
        List convertedValues = new ArrayList<>();
        for (CaptureStatus enumValue : toConvert) {
            convertedValues.add(enumValue.value);
        }
        return convertedValues;
    }
}