org.cp.elements.lang.ImmutableObjectException 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 ImmutableObjectException class is a RuntimeException indicating that a mutation operation was attempted 
 * on an immutable object.
 * 
 * @author John J. Blum
 * @see java.lang.RuntimeException
 * @since 1.0.0
 */
@SuppressWarnings("unused")
public class ImmutableObjectException extends RuntimeException {

  /**
   * Constructs an uninitialized instance of the ImmutableObjectException.
   */
  public ImmutableObjectException() {
  }

  /**
   * Constructs an instance of the ImmutableObjectException initialized with the given message describing
   * the immutability error.
   *
   * @param message a String describing the nature of the immutability error.
   */
  public ImmutableObjectException(final String message) {
    super(message);
  }

  /**
   * Constructs an instance of the ImmutableObjectException initialized with the given Throwable to indicate
   * the cause of the immutability error.
   *
   * @param cause the Throwable indicating the cause of the immutability error.
   * @see java.lang.Throwable
   */
  public ImmutableObjectException(final Throwable cause) {
    super(cause);
  }

  /**
   * Constructs an instance of the ImmutableObjectException initialized with the given message describing
   * the immutability error along with the Throwable indicating the probable cause of the immutability error.
   *
   * @param message a String describing the nature of the immutability error.
   * @param cause the Throwable indicating the cause of the immutability error.
   * @see java.lang.Throwable
   */
  public ImmutableObjectException(final String message, final Throwable cause) {
    super(message, cause);
  }

}