org.seasar.doma.DomaIllegalArgumentException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of doma-core Show documentation

DAO Oriented Database Mapping Framework for Java

There is a newer version: 3.3.0

/*
 * Copyright Doma 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
 *
 *     https://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.seasar.doma;

import org.seasar.doma.message.Message;

/**
 * Thrown to indicate that the argument does not meet any preconditions in the method.
 *
 * This class makes it easy to distinguish Doma's specifications from Doma's bugs.
 */
public class DomaIllegalArgumentException extends DomaException {

  private static final long serialVersionUID = 1L;

  /** the parameter name that corresponds to the illegal argument */
  protected final String parameterName;

  /** the detail message */
  protected final String description;

  /**
   * Constructs an instance.
   *
   * @param parameterName the parameter name
   * @param description the detail message
   */
  public DomaIllegalArgumentException(String parameterName, String description) {
    super(Message.DOMA0002, parameterName, description);
    this.parameterName = parameterName;
    this.description = description;
  }

  /**
   * Returns the parameter name that corresponds to the illegal argument.
   *
   * @return the parameter name
   */
  public String getParameterName() {
    return parameterName;
  }

  /**
   * Returns the detail message.
   *
   * @return the detail message
   */
  public String getDescription() {
    return description;
  }
}