com.github.mjeanroy.junit4.runif.conditions.SystemPropertyReadingException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of junit-runif Show documentation

Run unit test conditionally.

There is a newer version: 0.2.0

/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2018 Mickael Jeanroy
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.github.mjeanroy.junit4.runif.conditions;

/**
 * Exception thrown when a system property cannot be read because of
 * external error (such as {@link SecurityException}).
 */
public class SystemPropertyReadingException extends RuntimeException {
	/**
	 * The property that cannot be read.
	 */
	private final String property;

	/**
	 * Create the exception.
	 *
	 * @param cause The original exception.
	 * @param property The property that cannot be read.
	 */
	SystemPropertyReadingException(Exception cause, String property) {
		super(createMessage(property), cause);
		this.property = property;
	}

	/**
	 * Get the property that is impossible to read.
	 *
	 * @return The property.
	 */
	public String getProperty() {
		return property;
	}

	/**
	 * Create the exception error message.
	 *
	 * @param property Property that is impossible to read.
	 * @return The error message.
	 */
	private static String createMessage(String property) {
		return "Error while reading the system property '" + property + "'";
	}
}