com.arm.mbed.cloud.sdk.update.model.CampaignState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of foundation-models Show documentation

The Pelion Cloud SDK (formerly known as Mbed Cloud SDK) provides a simplified interface to the Pelion Cloud APIs by exposing functionality using conventions and paradigms familiar to Java developers.

There is a newer version: 2.5.0

Show newest version

package com.arm.mbed.cloud.sdk.update.model;

import com.arm.mbed.cloud.sdk.annotations.Preamble;
import com.arm.mbed.cloud.sdk.common.SdkEnum;

@Preamble(description = "campaign state")
public enum CampaignState implements SdkEnum {

    DRAFT("draft"),
    DEVICE_CHECK("devicecheck"),
    AUTO_STOPPED("autostopped"),
    SCHEDULED("scheduled"),
    DEVICE_FETCH("devicefetch"),
    DEVICE_COPY("devicecopy"),
    PUBLISHING("publishing"),
    DEPLOYING("deploying"),
    DEPLOYED("deployed"),
    MANIFEST_REMOVED("manifestremoved"),
    EXPIRED("expired"),
    STOPPING("stopping"),
    USER_STOPPED("userstopped"),
    ALLOCATED_QUOTA("allocatedquota"),
    ALLOCATING_QUOTA("allocatingquota"),
    ALLOCATING_QUOTA_FAILED("quotaallocationfailed"),
    CONFLICT("conflict"),
    CHECKED_MANIFEST("checkedmanifest"),
    CHECKING_MANIFEST("checkingmanifest"),
    UNKNOWN_ENUM(SDK_UNKNOWN_ENUM_VALUE);

    private final String value;

    /**
     * Constructor.
     * 
     * @param value
     *            string representation.
     */
    private CampaignState(String value) {
        this.value = value;
    }

    /**
     * States whether it is the default value.
     * 
     * @see SdkEnum#isDefault()
     */
    @Override
    public boolean isDefault() {
        return this == getDefault();
    }

    /**
     * States whether the value is unknown and an error happened during parsing.
     * 
     * @see SdkEnum#isUnknownValue()
     */
    @Override
    public boolean isUnknownValue() {
        return this == getUnknownEnum();
    }

    /**
     * Gets string representation.
     * 
     * @see SdkEnum#getString()
     */
    @Override
    public String getString() {
        return value;
    }

    /**
     * ToString.
     * 
     * @see java.lang.Enum#toString()
     */
    @Override
    public String toString() {
        return getString();
    }

    /**
     * Gets default state.
     * 
     * @return default state.
     */
    public static CampaignState getDefault() {
        return DRAFT;
    }

    /**
     * Gets Unknown state value.
     * 
     * @return unknown state.
     */
    public static CampaignState getUnknownEnum() {
        return UNKNOWN_ENUM;
    }

    /**
     * Gets state from its string representation.
     * 
     * @param value
     *            string
     * @return corresponding state or default state if not recognised.
     */
    public static CampaignState getState(String value) {
        if (value == null) {
            return getDefault();
        }
        final String trimmedValue = value.trim();
        for (final CampaignState state : values()) {
            if (state.getString().equalsIgnoreCase(trimmedValue)) {
                return state;
            }
        }
        return getDefault();
    }

    /**
     * Merges two states.
     * 
     * @see SdkEnum#merge(SdkEnum, SdkEnum)
     */
    @Override
    public  T merge(T obj1, T obj2) {
        if (obj1 == null) {
            return obj2;
        }
        if (obj2 == null) {
            return obj1;
        }
        if (obj1.isDefault()) {
            return obj2;
        }
        if (obj2.isDefault()) {
            return obj1;
        }
        return obj2;
    }
}