com.exasol.projectkeeper.shared.config.workflow.WorkflowStep Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of project-keeper-shared-model-classes Show documentation

Classes that need to be shared between different modules of project-keeper.

The newest version!

package com.exasol.projectkeeper.shared.config.workflow;

import java.util.*;

/**
 * A build step in a GitHub workflow.
 */
public final class WorkflowStep {

    private final Map rawStep;

    private WorkflowStep(final Map rawStep) {
        this.rawStep = Objects.requireNonNull(rawStep, "rawStep");
    }

    /**
     * Create a list of workflow steps from a list of raw steps parsed from a YAML file.
     * 
     * @param setupSteps list of raw steps
     * @return list of workflow steps
     */
    public static List createSteps(final List> setupSteps) {
        return setupSteps.stream().map(WorkflowStep::createStep).toList();
    }

    /**
     * Create a workflow step from a raw step parsed from a YAML file.
     * 
     * @param buildStep raw step
     * @return workflow step
     */
    public static WorkflowStep createStep(final Map buildStep) {
        return new WorkflowStep(buildStep);
    }

    /**
     * Get the ID of the step or {@code null} if no ID is set.
     * 
     * @return step ID
     */
    public String getId() {
        return (String) this.rawStep.get("id");
    }

    /**
     * Get the original raw content of the step.
     * 
     * @return original raw content
     */
    public Map getRawStep() {
        return rawStep;
    }

    @Override
    public String toString() {
        return "WorkflowStep [rawStep=" + rawStep + "]";
    }

    @Override
    public int hashCode() {
        return Objects.hash(rawStep);
    }

    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final WorkflowStep other = (WorkflowStep) obj;
        return Objects.equals(rawStep, other.rawStep);
    }
}