org.cp.elements.lang.EqualityException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cp-elements Show documentation

Java Simplified. Extensions and Useful Constructs for the Java Platform. Codeprimate Elements (a.k.a. cp-elements) is a Java library and micro-framework used to simplify the development of software applications written in Java. Elements packages several APIs into one library in order to address various application concerns and aspects of software design and development collectively and conveniently. Elements is a highly simple, yet robust and proven library built on solid OO principles, software design patterns and best practices to effectively solve common and reoccurring problems in software development.

There is a newer version: 2.0.0-M1

Show newest version

/*
 * Copyright 2016 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
 *
 *     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 org.cp.elements.lang;

/**
 * The EqualityException class is an IllegalArgumentException indicating that two objects are not equal.
 * 
 * @author John J. Blum
 * @see java.lang.IllegalArgumentException
 * @since 1.0.0
 */
@SuppressWarnings("unused")
public class EqualityException extends IllegalArgumentException {

  /**
   * Default constructor creating an instance of the EqualityException.
   */
  public EqualityException() {
  }

  /**
   * Constructor to create an instance of the EqualityException with the given message to describe the equality
   * comparison error.
   * 
   * @param message a String value describing the nature of the equality comparison error.
   */
  public EqualityException(final String message) {
    super(message);
  }

  /**
   * Constructor to create an instance of the EqualityException with the given Throwable to indicate the cause
   * of the equality comparison error.
   * 
   * @param cause the Throwable indicated as the cause of this equality comparison error.
   */
  public EqualityException(final Throwable cause) {
    super(cause);
  }

  /**
   * Constructor to create an instance of the EqualityException with a message to describe the equality comparison error
   * and a Throwable to indicate the probable cause of the equality comparison error.
   * 
   * @param message a String value describing the nature of the equality comparison error.
   * @param cause the Throwable indicated as the cause of this equality comparison error.
   */
  public EqualityException(final String message, final Throwable cause) {
    super(message, cause);
  }

}