com.sandpolis.core.instance.OutcomeSet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sandpolis-core-instance Show documentation
The instance library module
There is a newer version: 6.1.0
Show newest version
/*******************************************************************************
 *                                                                             *
 *                Copyright © 2015 - 2019 Subterranean Security                *
 *                                                                             *
 *  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.sandpolis.core.instance;

import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;

import com.sandpolis.core.proto.util.Result.Outcome;

/**
 * A {@link Set} of {@link Outcome}s representing the overall result of some
 * larger action which may consist of multiple components.
 *
 * @author cilki
 * @since 4.0.0
 */
public final class OutcomeSet extends HashSet {

	private static final long serialVersionUID = 1L;

	/**
	 * Add an outcome to the set.
	 *
	 * @param outcome The outcome to add
	 */
	public void add(Outcome.Builder outcome) {
		add(outcome.build());
	}

	/**
	 * Get the current result.
	 *
	 * @return The overall outcome of the {@code OutcomeSet}
	 */
	public boolean getResult() {
		for (Outcome outcome : this)
			if (!outcome.getResult())
				return false;
		return true;
	}

	/**
	 * Get one of the failed outcomes.
	 *
	 * @return A failed outcome or {@code null} if all outcomes succeeded
	 */
	public Outcome getOneFailed() {
		return stream().filter(outcome -> !outcome.getResult()).findAny().orElse(null);
	}

	/**
	 * Get all failed outcomes.
	 *
	 * @return A list of all failed outcomes in the {@code OutcomeSet}
	 */
	public List getFailed() {
		return stream().filter(outcome -> !outcome.getResult()).collect(Collectors.toList());
	}

	/**
	 * Get all passed outcomes.
	 *
	 * @return A list of all passed outcomes in the {@code OutcomeSet}
	 */
	public List getPassed() {
		return stream().filter(outcome -> outcome.getResult()).collect(Collectors.toList());
	}

	/**
	 * Get the total duration.
	 *
	 * @return The cumulative duration of all outcomes in the {@code OutcomeSet}.
	 */
	public long getTime() {
		return stream().mapToLong(Outcome::getTime).sum();
	}

}