/*
 * Copyright 2021-2022 the original author or authors.
 *
 * 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
 *
 *      https://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.opentest4j.reporting.events.core;

import org.opentest4j.reporting.events.api.ChildElement;
import org.opentest4j.reporting.events.api.Context;
import org.opentest4j.reporting.events.root.Event;
import org.opentest4j.reporting.schema.Namespace;
import org.opentest4j.reporting.schema.QualifiedName;

/**
 * The {@code result} element of the core namespace.
 */
public class Result extends ChildElement<Event, Result> {

	private static final QualifiedName ELEMENT = QualifiedName.of(Namespace.REPORTING_CORE, "result");
	private static final QualifiedName STATUS = QualifiedName.of(Namespace.REPORTING_CORE, "status");

	Result(Context context) {
		super(context, ELEMENT);
	}

	Result withStatus(Status status) {
		withAttribute(STATUS, status.name());
		return this;
	}

	/**
	 * Enum of values for the {@code status} attribute of the {@code result} element.
	 */
	public enum Status {

		/**
		 * The test was skipped.
		 */
		SKIPPED,

		/**
		 * The test was aborted.
		 */
		ABORTED,

		/**
		 * The test was successful.
		 */
		SUCCESSFUL,

		/**
		 * The test failed.
		 */
		FAILED
	}
}
