edu.stanford.math.plex4.utility

Class ExceptionUtility

java.lang.Object

edu.stanford.math.plex4.utility.ExceptionUtility

public class ExceptionUtility
extends java.lang.Object

This class contains static functions for aiding in creating exceptions, and verifying exceptions. The methods starting with verify check a condition on the arguments. If the condition is not satisfied, and appropriate exception is thrown.

Author:

Andrew Tausz

Constructor Summary

Constructors

Constructor and Description
ExceptionUtility()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> void	verifyAllNonNull(java.util.Collection<T> collection)
static void	verifyClosedInterval(double value, double lowerBound, double upperBound)
static void	verifyClosedInterval(int value, int lowerBound, int upperBound)
static void	verifyEqual(double value1, double value2)
static void	verifyEqual(int value1, int value2)
static void	verifyFalse(boolean condition)
static void	verifyFalse(boolean condition, java.lang.String message)
static void	verifyGreaterThan(double value1, double value2)
static void	verifyGreaterThan(int value1, int value2)
static void	verifyGreaterThanOrEqual(double value1, double value2)
static void	verifyGreaterThanOrEqual(int value1, int value2)
static void	verifyIndex(int upperBound, int index) This function checks to see if index is in the set {0, ..., upperBound - 1}.
static void	verifyIndex(int lowerBound, int upperBound, int index) This function checks to see if index is in the set {lowerBound, ..., upperBound - 1}.
static void	verifyLeftHalfOpenInterval(double value, double lowerBound, double upperBound)
static void	verifyLessThan(double value1, double value2)
static void	verifyLessThan(int value1, int value2)
static void	verifyLessThanOrEqual(double value1, double value2)
static void	verifyLessThanOrEqual(int value1, int value2)
static void	verifyNegative(double value)
static void	verifyNegative(int value)
static <T> void	verifyNonEmpty(java.util.Collection<T> collection)
static <T> void	verifyNonEmpty(double[] collection)
static <T> void	verifyNonEmpty(int[] collection)
static void	verifyNonEqual(double value1, double value2)
static void	verifyNonEqual(int value1, int value2)
static void	verifyNonNegative(double value)
static void	verifyNonNegative(int value)
static void	verifyNonNull(java.lang.Object value)
static void	verifyNonPositive(double value)
static void	verifyNonPositive(int value)
static void	verifyNonZero(double value)
static void	verifyNonZero(int value)
static void	verifyOpenInterval(double value, double lowerBound, double upperBound)
static void	verifyPositive(double value)
static void	verifyPositive(int value)
static void	verifyRightHalfOpenInterval(double value, double lowerBound, double upperBound)
static void	verifyTrue(boolean condition)
static void	verifyTrue(boolean condition, java.lang.String message)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExceptionUtility

public ExceptionUtility()

Method Detail

verifyIndex

public static void verifyIndex(int lowerBound,
               int upperBound,
               int index)

This function checks to see if index is in the set {lowerBound, ..., upperBound - 1}.

Parameters:

lowerBound - the minimum allowable value of index

upperBound - one past the maximum allowable value of index

index - the index to check

verifyIndex

public static void verifyIndex(int upperBound,
               int index)

This function checks to see if index is in the set {0, ..., upperBound - 1}.

Parameters:

upperBound - one past the maximum allowable value of index

index - the index to check

verifyNonNull

public static void verifyNonNull(java.lang.Object value)

verifyAllNonNull

public static <T> void verifyAllNonNull(java.util.Collection<T> collection)

verifyNonEmpty

public static <T> void verifyNonEmpty(java.util.Collection<T> collection)

verifyNonEmpty

public static <T> void verifyNonEmpty(int[] collection)

verifyNonEmpty

public static <T> void verifyNonEmpty(double[] collection)

verifyEqual

public static void verifyEqual(int value1,
               int value2)

verifyNonEqual

public static void verifyNonEqual(int value1,
                  int value2)

verifyLessThan

public static void verifyLessThan(int value1,
                  int value2)

verifyGreaterThan

public static void verifyGreaterThan(int value1,
                     int value2)

verifyLessThanOrEqual

public static void verifyLessThanOrEqual(int value1,
                         int value2)

verifyGreaterThanOrEqual

public static void verifyGreaterThanOrEqual(int value1,
                            int value2)

verifyPositive

public static void verifyPositive(int value)

verifyNonNegative

public static void verifyNonNegative(int value)

verifyNegative

public static void verifyNegative(int value)

verifyNonPositive

public static void verifyNonPositive(int value)

verifyNonZero

public static void verifyNonZero(int value)

verifyClosedInterval

public static void verifyClosedInterval(int value,
                        int lowerBound,
                        int upperBound)

verifyEqual

public static void verifyEqual(double value1,
               double value2)

verifyNonEqual

public static void verifyNonEqual(double value1,
                  double value2)

verifyLessThan

public static void verifyLessThan(double value1,
                  double value2)

verifyGreaterThan

public static void verifyGreaterThan(double value1,
                     double value2)

verifyLessThanOrEqual

public static void verifyLessThanOrEqual(double value1,
                         double value2)

verifyGreaterThanOrEqual

public static void verifyGreaterThanOrEqual(double value1,
                            double value2)

verifyPositive

public static void verifyPositive(double value)

verifyNonNegative

public static void verifyNonNegative(double value)

verifyNegative

public static void verifyNegative(double value)

verifyNonPositive

public static void verifyNonPositive(double value)

verifyNonZero

public static void verifyNonZero(double value)

verifyClosedInterval

public static void verifyClosedInterval(double value,
                        double lowerBound,
                        double upperBound)

verifyOpenInterval

public static void verifyOpenInterval(double value,
                      double lowerBound,
                      double upperBound)

verifyLeftHalfOpenInterval

public static void verifyLeftHalfOpenInterval(double value,
                              double lowerBound,
                              double upperBound)

verifyRightHalfOpenInterval

public static void verifyRightHalfOpenInterval(double value,
                               double lowerBound,
                               double upperBound)

verifyTrue

public static void verifyTrue(boolean condition)

verifyFalse

public static void verifyFalse(boolean condition)

verifyTrue

public static void verifyTrue(boolean condition,
              java.lang.String message)

verifyFalse

public static void verifyFalse(boolean condition,
               java.lang.String message)