Status.java

/* 
 * 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.ngrinder.model;

import java.util.ArrayList;
import java.util.List;

/**
 * Performance Test Status. This enum describes all necessary step and status which {@link PerfTest}
 * can be in.
 *
 * @author JunHo Yoon
 * @since 3.0
 */
public enum Status {
	/**
	 * Just Saved.. not ready to run
	 */
	SAVED(StatusCategory.PREPARE),
	/**
	 * test ready.
	 */
	READY(StatusCategory.PREPARE),
	/**
	 * Just before starting console.
	 */
	START_CONSOLE(StatusCategory.PROGRESSING),
	/**
	 * Just after staring console.
	 */
	START_CONSOLE_FINISHED(StatusCategory.PROGRESSING),
	/**
	 * Just before starting agents.
	 */
	START_AGENTS(StatusCategory.PROGRESSING),
	/**
	 * Just after starting agents.
	 */
	START_AGENTS_FINISHED(StatusCategory.PROGRESSING),
	/**
	 * Just before distributing files.
	 */
	DISTRIBUTE_FILES(StatusCategory.PROGRESSING),
	/**
	 * Just after distributing files.
	 */
	DISTRIBUTE_FILES_FINISHED(StatusCategory.PROGRESSING),
	/**
	 * Just before staring testing.
	 */
	START_TESTING(StatusCategory.TESTING),
	/**
	 * Just after staring testing.
	 */
	TESTING(StatusCategory.TESTING),
	/**
	 * Waiting for test is finishing.
	 */
	TESTING_FINISHED(StatusCategory.TESTING),
	/**
	 * Detected Abnormal testing.
	 */
	ABNORMAL_TESTING(StatusCategory.TESTING),
	/**
	 * Test finished.
	 */
	FINISHED(StatusCategory.FINISHED),

	/**
	 * Test finished. but contains lots of error
	 */
	STOP_BY_ERROR(StatusCategory.ERROR),
	/**
	 * Test finished. but contains lots of error.
	 *
	 * @deprecated deprecated by typo error. use {@link #STOP_BY_ERROR}.
	 */
	STOP_ON_ERROR(StatusCategory.ERROR),
	/**
	 * Test cancel.
	 */
	CANCELED(StatusCategory.STOP),
	/**
	 * Nothing.
	 */
	UNKNOWN(StatusCategory.STOP);

	private final StatusCategory category;

	/**
	 * Constructor.
	 *
	 * @param category category of this status within.
	 */
	Status(StatusCategory category) {
		this.category = category;
	}

	/**
	 * Get the category of each status.
	 *
	 * @return category.
	 */
	public StatusCategory getCategory() {
		return category;
	}

	/**
	 * Check if the {@link PerfTest} in this status can be stopped.
	 *
	 * @return true if stoppable.
	 */
	public boolean isStoppable() {
		return category.isStoppable();
	}


	/**
	 * Check if the {@link PerfTest} contains report.
	 *
	 * @return true if reportable.
	 */
	public boolean isReportable() {
		return category.isReportable();
	}

	/**
	 * Check if the {@link PerfTest} in this status can be deleted.
	 *
	 * @return true if deletable.
	 */
	public boolean isDeletable() {
		return category.isDeletable();
	}

	/**
	 * Get the icon name of this status.
	 *
	 * @return icon name
	 */
	public String getIconName() {
		return category.getIconName();
	}

	/**
	 * Return all status which is processing or testing {@link StatusCategory}s.
	 *
	 * @return status array.
	 */
	public static Status[] getProcessingOrTestingTestStatus() {
		List<Status> status = new ArrayList<Status>();
		for (Status each : values()) {
			if (isWorkingStatus(each)) {
				status.add(each);
			}
		}
		return status.toArray(new Status[status.size()]);
	}

	/**
	 * Check this status is the working status.
	 *
	 * @param status status
	 * @return true if it's in {@link StatusCategory}'s PROCESSING or TESTING.
	 */
	private static boolean isWorkingStatus(Status status) {
		return status.getCategory() == StatusCategory.PROGRESSING || status.getCategory() == StatusCategory.TESTING;
	}

	/**
	 * Get all statuses in TESTING {@link StatusCategory}.
	 *
	 * @return status list
	 */
	public static Status[] getTestingTestStates() {
		List<Status> status = new ArrayList<Status>();
		for (Status each : values()) {
			if (each.getCategory() == StatusCategory.TESTING) {
				status.add(each);
			}
		}
		return status.toArray(new Status[status.size()]);
	}

	/**
	 * Get the message key of {@link Status}.
	 *
	 * @return message key
	 */
	public String getSpringMessageKey() {
		return "perftest.status." + name().toLowerCase();
	}
}