io.github.primelib.jira4j.restv3.model.JiraWorkflowStatus Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jira4j-rest-v3 Show documentation
A Java Wrapper for the Jira REST API
The newest version!
package io.github.primelib.jira4j.restv3.model;

import java.util.function.Consumer;
import org.jetbrains.annotations.ApiStatus;
import javax.annotation.processing.Generated;
import lombok.AccessLevel;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import lombok.EqualsAndHashCode;
import lombok.ToString;
import lombok.NoArgsConstructor;
import lombok.AllArgsConstructor;
import lombok.experimental.Accessors;

import java.util.Set;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

/**
 * JiraWorkflowStatus
 *
 */
@Getter
@Setter
@EqualsAndHashCode
@ToString
@Accessors(fluent = true, chain = true)
@NoArgsConstructor(access = AccessLevel.PROTECTED, force = true)
@Builder
@JsonPropertyOrder({
    "description",
    "id",
    "name",
    "scope",
    "statusCategory",
    "statusReference",
    "usages"
})
@JsonTypeName("JiraWorkflowStatus")
@Generated(value = "io.github.primelib.primecodegen.javafeign.JavaFeignGenerator")
public class JiraWorkflowStatus {

    /**
     * The description of the status.
     */
    @JsonProperty("description")
    protected String description;

    /**
     * The ID of the status.
     */
    @JsonProperty("id")
    protected String id;

    /**
     * The name of the status.
     */
    @JsonProperty("name")
    protected String name;

    @JsonProperty("scope")
    protected WorkflowScope scope;

    /**
     * The category of the status.
     */
    @JsonProperty("statusCategory")
    protected StatusCategoryEnum statusCategory;

    /**
     * The reference of the status.
     */
    @JsonProperty("statusReference")
    protected String statusReference;

    /**
     * The {@code statuses.usages} expand is an optional parameter that can be used when reading and updating statuses in Jira. It provides additional information about the projects and issue types associated with the requested statuses.
     */
    @JsonProperty("usages")
    protected Set usages;

    /**
     * Constructs a validated instance of {@link JiraWorkflowStatus}.
     *
     * @param spec the specification to process
     */
    public JiraWorkflowStatus(Consumer spec) {
        spec.accept(this);
    }

    /**
     * Constructs a validated instance of {@link JiraWorkflowStatus}.
     * 
     * NOTE: This constructor is not considered stable and may change if the model is updated. Consider using {@link #JiraWorkflowStatus(Consumer)} instead.
     * @param description The description of the status.
     * @param id The ID of the status.
     * @param name The name of the status.
     * @param scope scope
     * @param statusCategory The category of the status.
     * @param statusReference The reference of the status.
     * @param usages The {@code statuses.usages} expand is an optional parameter that can be used when reading and updating statuses in Jira. It provides additional information about the projects and issue types associated with the requested statuses.
     */
    @ApiStatus.Internal
    public JiraWorkflowStatus(String description, String id, String name, WorkflowScope scope, StatusCategoryEnum statusCategory, String statusReference, Set usages) {
        this.description = description;
        this.id = id;
        this.name = name;
        this.scope = scope;
        this.statusCategory = statusCategory;
        this.statusReference = statusReference;
        this.usages = usages;
    }

    /**
     * The category of the status.
     */
    @AllArgsConstructor
    public enum StatusCategoryEnum {
        TODO("TODO"),
        IN_PROGRESS("IN_PROGRESS"),
        DONE("DONE");

        private static final StatusCategoryEnum[] VALUES = values(); // prevent allocating a new array for every call to values()
        private final String value;

        @JsonCreator
        public static StatusCategoryEnum of(String input) {
            if (input != null) {
                for (StatusCategoryEnum v : VALUES) {
                    if (input.equalsIgnoreCase(v.value)) 
                        return v;
                }
            }

            return null;
        }

        @JsonValue
        public String getValue() {
            return value;
        }
    }

}