com.googlecode.kevinarpe.papaya.exception.InvalidExitValueException Maven / Gradle / Ivy
package com.googlecode.kevinarpe.papaya.exception;
/*
* #%L
* This file is part of Papaya.
* %%
* Copyright (C) 2013 - 2014 Kevin Connor ARPE ([email protected])
* %%
* Papaya is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* GPL Classpath Exception:
* This project is subject to the "Classpath" exception as provided in
* the LICENSE file that accompanied this code.
*
* Papaya is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Papaya. If not, see _validExitValueList;
/**
* This is a convenience method for
* {@link #InvalidExitValueException(int, Collection, Throwable, String, Object...)}
* where param {@code optCause} is {@code null}.
*/
public InvalidExitValueException(
int exitValue,
Collection validExitValueCollection,
String format,
Object... optArgArr) {
this(exitValue, validExitValueCollection, null, false, format, optArgArr);
}
/**
* Constructor. The message, as specified by parameters {@code format} and {@code optArgArr}
* has a suffix appended with additional details about actual vs. allowed exit values. The
* message need not specify these details.
*
* Example {@code format}: {@code "Failed to run external filter command: %s"}
* Example {@code optArgArr}: (filter command arguments)
*
* @param exitValue
*
* - actual exit value from child process
* - Accessible via {@link #getExitValue()}
*
* @param validExitValueCollection
*
* - non-empty collection of expected (or valid) child process exit values
* - Must not be empty or contain {@code null} values
* - Must not contain the actual exit value from parameter {@code exitValue}
* - This collection is copied
*
* @param optCause
*
* - optional underlying cause of this exception that is passed directory to superclass
* constructor
* - May be {@code null}
* - Access via {@link #getCause()}
* - The placement of this argument compared to the
* {@linkplain #InvalidExitValueException(int, Collection, String, Object...) other constructor}
* may appear odd. This is necessary as parameters {@code format} and {@code optArgArr} form
* a pair, where (i) {@code optArgArr} is varargs, and (ii) both are passed directly to
* {@link String#format(String, Object...)}.
*
* @param format
*
* - passed directly to {@link String#format(String, Object...)}
* - must not be {@code null}, empty, or only
* {@linkplain Character#isWhitespace(char) whitespace}
*
* @param optArgArr
* optional list of arguments to pass directly to
* {@link String#format(String, Object...)}
*
* @throws NullPointerException
*
* - if {@code validExitValueCollection} is {@code null} or contains {@code null}
* elements
* - if {@code format} is {@code null}
*
* @throws IllegalArgumentException
*
* - if {@code validExitValueCollection} is empty
* - if {@code format} is empty or only
* {@linkplain Character#isWhitespace(char) whitespace}
* - if {@code validExitValueCollection} contains {@code exitValue}
*
*/
public InvalidExitValueException(
int exitValue,
Collection validExitValueCollection,
Throwable optCause,
String format,
Object... optArgArr) {
this(exitValue, validExitValueCollection, optCause, false, format, optArgArr);
}
/**
* Copy constructor.
*
* @throws NullPointerException
* if {@code other} is {@code null}
*/
public InvalidExitValueException(InvalidExitValueException other) {
this(
ObjectArgs.checkNotNull(other, "other").getExitValue(),
other.getValidExitValueList(),
other.getCause(),
true,
other.getMessage());
}
/**
* Root constructor for copies and non-copies.
*
* @param exitValue
* @param validExitValueCollection
* @param optCause
* @param isCopy
*
* - if {@code true}, this is a copy constructor call -- copy the message exactly
* - if {@code false}, this is not a copy constructor call -- append the message
* with additional details
*
* @param format
* @param optArgArr
*/
protected InvalidExitValueException(
int exitValue,
Collection validExitValueCollection,
Throwable optCause,
boolean isCopy,
String format,
Object... optArgArr) {
super(
_createMessage(exitValue, validExitValueCollection, isCopy, format, optArgArr),
optCause);
if (validExitValueCollection.contains(exitValue)) {
String x = String.format("Exit value %d is found in list of valid exit values: %s",
exitValue,
Joiner.on(", ").join(validExitValueCollection));
throw new IllegalArgumentException(x);
}
_exitValue = exitValue;
_validExitValueList = ImmutableList.copyOf(validExitValueCollection);
}
private static String _createMessage(
int exitValue,
Collection validExitValueCollection,
boolean isCopy,
String format,
Object[] optArgArr) {
CollectionArgs.checkNotEmptyAndElementsNotNull(
validExitValueCollection, "validExitValueCollection");
StringArgs.checkNotEmptyOrWhitespace(format, "format");
String x = String.format(format, optArgArr);
if (!isCopy) {
x += String.format(
"%nInvalid exit value: %d%nValid values: %s",
exitValue,
Joiner.on(", ").join(validExitValueCollection));
}
return x;
}
/**
* @return actual exit value from child process
*/
public int getExitValue() {
return _exitValue;
}
/**
* @return immutable, non-empty list of expected (or valid) child process exit values
*/
public List getValidExitValueList() {
return _validExitValueList;
}
@Override
public int hashCode() {
int result = Objects.hashCode(getExitValue(), getValidExitValueList());
result = 31 * result + ThrowableUtils.hashCode(this, IncludeStackTrace.YES);
return result;
}
@Override
public boolean equals(Object obj) {
// Ref: http://stackoverflow.com/a/5039178/257299
boolean result = (this == obj);
if (!result && obj instanceof InvalidExitValueException) {
final InvalidExitValueException other = (InvalidExitValueException) obj;
result =
ThrowableUtils.equals(this, other, IncludeStackTrace.YES)
&& this.getExitValue() == other.getExitValue()
&& Objects.equal(this.getValidExitValueList(), other.getValidExitValueList());
}
return result;
}
/**
* Used by test code.
*/
boolean equalsExcludingStackTrace(Object obj) {
// Ref: http://stackoverflow.com/a/5039178/257299
boolean result = (this == obj);
if (!result && obj instanceof InvalidExitValueException) {
final InvalidExitValueException other = (InvalidExitValueException) obj;
result =
ThrowableUtils.equals(this, other, IncludeStackTrace.NO)
&& this.getExitValue() == other.getExitValue()
&& Objects.equal(this.getValidExitValueList(), other.getValidExitValueList());
}
return result;
}
@Override
public String toString() {
String x = String.format(
"class %s ["
+ "%n\tgetExitValue()=%s,"
+ "%n\tgetValidExitValueList()='%s',%s",
InvalidExitValueException.class.getCanonicalName(),
getExitValue(),
Joiner.on(", ").join(getValidExitValueList()),
ThrowableUtils.toString(this));
return x;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy