io.guise.framework.platform.web.WebProgressDepictEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation
Guise™ Internet application framework.
There is a newer version: 0.5.3
/*
 * Copyright © 2005-2008 GlobalMentor, Inc. 
 *
 * 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 io.guise.framework.platform.web;

import static java.util.Objects.*;

import com.globalmentor.model.TaskState;

import io.guise.framework.platform.DepictedObject;

/**
 * Indicates that some sort of progress has been made on the web platform.
 * @author Garret Wilson
 */
public class WebProgressDepictEvent extends AbstractWebDepictEvent {

	/** The task being performed, or null if not indicated. */
	private String task;

	/** @return The task being performed, or null if not indicated. */
	public String getTask() {
		return task;
	}

	/** The state of the task. */
	private TaskState taskState;

	/** @return The state of the task. */
	public TaskState getTaskState() {
		return taskState;
	}

	/** The amount of progress that has been made, or -1 if the progress is unknown. */
	private final long progress;

	/** @return The amount of progress that has been made, or -1 if the progress is unknown. */
	public long getProgress() {
		return progress;
	}

	/** The total amount of progress that will have been made upon completion, or -1 if the goal is unknown. */
	private final long goal;

	/** @return The total amount of progress that will have been made upon completion, or -1 if the goal is unknown. */
	public long getGoal() {
		return goal;
	}

	/**
	 * Depicted object constructor with an unknown goal.
	 * @param depictedObject The depicted object on which the event initially occurred.
	 * @param task The task being performed, or null if not indicated.
	 * @param taskState The state of the task.
	 * @param progress The amount of progress that has been made, or -1 if the progress is unknown.
	 * @throws NullPointerException if the given depicted object and/or task state is null.
	 */
	public WebProgressDepictEvent(final DepictedObject depictedObject, final String task, final TaskState taskState, final long progress) {
		this(depictedObject, task, taskState, progress, -1); //construct the class with an unknown goal
	}

	/**
	 * Depicted object and goal constructor.
	 * @param depictedObject The depicted object on which the event initially occurred.
	 * @param task The task being performed, or null if not indicated.
	 * @param taskState The state of the task.
	 * @param progress The amount of progress that has been made, or -1 if the progress is unknown.
	 * @param goal The total amount of progress that will have been made upon completion, or -1 if the goal is unknown.
	 * @throws NullPointerException if the given depicted object and/or task state is null.
	 */
	public WebProgressDepictEvent(final DepictedObject depictedObject, final String task, final TaskState taskState, final long progress, final long goal) {
		super(depictedObject); //construct the parent class
		this.task = task;
		this.taskState = requireNonNull(taskState, "Task state cannot be null.");
		this.progress = progress;
		this.goal = goal;
	}
}