org.jppf.management.TaskInformation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jppf-common Show documentation
JPPF, the open source grid computing solution
There is a newer version: 6.3-alpha
/*
 * JPPF.
 * Copyright (C) 2005-2015 JPPF Team.
 * http://www.jppf.org
 *
 * 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 org.jppf.management;

import java.io.Serializable;

/**
 * Instances of this class encapsulate runtime information on tasks executed by a node.
 * @author Laurent Cohen
 */
public class TaskInformation implements Serializable {
  /**
   * Explicit serialVersionUID.
   */
  private static final long serialVersionUID = 1L;
  /**
   * The task id.
   */
  private final String id;
  /**
   * The id of the job this task belongs to.
   */
  private final String jobId;
  /**
   * The name of the job this task belongs to.
   */
  private final String jobName;
  /**
   * The cpu time taken by the task.
   */
  private final long cpuTime;
  /**
   * The wall clock time taken by the task.
   */
  private final long elapsedTime;
  /**
   * Determines whether the task had an exception.
   */
  private final boolean error;
  /**
   * Timestamp for the creation of this event.
   */
  private final long timestamp = System.currentTimeMillis();
  /**
   * The position of the task in the job to which it belongs.
   * @since 5.0
   */
  private final int jobPosition;

  /**
   * Initialize this event object with the specified task.
   * @param id the task id.
   * @param jobId the id of the job this task belongs to.
   * @param jobName the name of the job this task belongs to.
   * @param cpuTime the cpu time taken by the task.
   * @param elapsedTime the wall clock time taken by the task.
   * @param error determines whether the task had an exception.
   * @param jobPosition the position of the task in the job to which it belongs..
   * @exclude
   */
  public TaskInformation(final String id, final String jobId, final String jobName, final long cpuTime, final long elapsedTime, final boolean error, final int jobPosition) {
    this.id = id;
    this.jobId = jobId;
    this.jobName = jobName;
    this.cpuTime = cpuTime;
    this.elapsedTime = elapsedTime;
    this.error = error;
    this.jobPosition = jobPosition;
  }

  /**
   * Get the task id.
   * @return the id as a string.
   */
  public String getId() {
    return id;
  }

  /**
   * Get the id of the job this task belongs to.
   * @return the job id as a string.
   */
  public String getJobId() {
    return jobId;
  }

  /**
   * Get the name of the job this task belongs to.
   * @return the job name as a string.
   */
  public String getJobName() {
    return jobName;
  }

  /**
   * Get the cpu time taken by the task.
   * @return the cpu time in milliseconds.
   */
  public long getCpuTime() {
    return cpuTime;
  }

  /**
   * Get the wall clock time taken by the task.
   * @return the elapsed time in milliseconds.
   */
  public long getElapsedTime() {
    return elapsedTime;
  }

  /**
   * Determines whether the task had an exception.
   * @return true if the task had an exception, false otherwise.
   */
  public boolean hasError() {
    return error;
  }

  /**
   * Get the timestamp for the creation of this event.
   * @return the timestamp as a long value.
   */
  public long getTimestamp() {
    return timestamp;
  }

  /**
   * Get the position of the task in the job to which it belongs.
   * @return the position of the task in its job as an int value.
   * @since 5.0
   */
  public int getJobPosition() {
    return jobPosition;
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder(getClass().getSimpleName());
    sb.append('[');
    sb.append("taskId=").append(id);
    sb.append(", jobId=").append(jobId);
    sb.append(", cpuTime=").append(cpuTime);
    sb.append(", elapsedTime=").append(elapsedTime);
    sb.append(", error=").append(error);
    return sb.toString();
  }
}