com.spotify.styx.model.WorkflowId Maven / Gradle / Ivy

Go to download
/*-
 * -\-\-
 * Spotify Styx Common
 * --
 * Copyright (C) 2017 Spotify AB
 * --
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * -/-/-
 */

package com.spotify.styx.model;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.auto.value.AutoValue;
import java.util.Comparator;

/**
 * A value for identifying a {@link Workflow}.
 *
 * This should be used instead of instances of {@link Workflow} in order to make references
 * independent of the current configuration of a {@link Workflow}.
 */
@AutoValue
public abstract class WorkflowId {

  public static final Comparator KEY_COMPARATOR =
      Comparator.comparing(WorkflowId::toKey);

  @JsonProperty
  public abstract String componentId();

  @JsonProperty
  public abstract String id();

  public String toKey() {
    // Used as ID in storage etc. Do not change.
    return componentId() + "#" + id();
  }

  @JsonCreator
  public static WorkflowId create(
      @JsonProperty("component_id") String componentId,
      @JsonProperty("id") String id) {
    return new AutoValue_WorkflowId(componentId, id);
  }

  public static WorkflowId ofWorkflow(Workflow workflow) {
    return new AutoValue_WorkflowId(workflow.componentId(), workflow.workflowId());
  }

  public static WorkflowId parseKey(String key) {
    final int hashPos = key.indexOf('#');
    if (hashPos < 1) {
      throw new IllegalArgumentException("Key must contain a hash '#' sign on position > 0");
    }

    return create(key.substring(0, hashPos), key.substring(hashPos + 1));
  }
}