com.cognifide.aet.communication.api.metadata.StepResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of communication-api Show documentation

API for communication between system elements - runners and workers

There is a newer version: 3.2.2

/**
 * Automated Exploratory Tests
 *
 * Copyright (C) 2013 Cognifide Limited
 *
 * 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.cognifide.aet.communication.api.metadata;

import com.google.common.base.Objects;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;

import org.apache.commons.lang3.StringUtils;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.validation.constraints.Pattern;

public abstract class StepResult implements Serializable {

  private static final long serialVersionUID = 7758484589529051815L;

  @Pattern(regexp = "^[0-9a-fA-F]{24}$", message = "Invalid objectID")
  private final String artifactId;

  private List errors = new ArrayList<>();

  private Map data = new HashMap<>();

  public StepResult(String artifactId) {
    this.artifactId = artifactId;
  }

  public String getArtifactId() {
    return artifactId;
  }

  public abstract String getStatusName();

  public Map getData() {
    return ImmutableMap.copyOf(data);
  }

  public String addData(String key, String value) {
    return data.put(key, value);
  }

  public void addError(String error) {
    if (StringUtils.isNotBlank(error)) {
      errors.add(error);
    }
  }

  public List getErrors() {
    return errors != null ? ImmutableList.copyOf(errors) : Collections.emptyList();
  }

  @Override
  public String toString() {
    return Objects.toStringHelper(this)
            .add("status", getStatusName())
            .add("artifactId", getArtifactId())
            .add("errors", getErrors())
            .add("data", getData())
            .toString();
  }
}