net.sf.mmm.util.pojo.descriptor.api.PojoPropertyNotFoundException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mmm-util-pojo Show documentation

This project provides common utitlities to for POJOs.

The newest version!

/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package net.sf.mmm.util.pojo.descriptor.api;

import net.sf.mmm.util.exception.api.NlsRuntimeException;
import net.sf.mmm.util.pojo.NlsBundleUtilPojoRoot;
import net.sf.mmm.util.pojo.descriptor.api.accessor.PojoPropertyAccessorMode;

/**
 * A {@link PojoPropertyNotFoundException} is thrown if a property should be accessed that does NOT exist (was NOT
 * found) or can NOT be accessed in the intended way.
 *
 * @see PojoDescriptor#getProperty(Object, String)
 * @see PojoDescriptor#setProperty(Object, String, Object)
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.1.0
 */
public class PojoPropertyNotFoundException extends NlsRuntimeException {

  private static final long serialVersionUID = -7713121978429674081L;

  /** @see #getCode() */
  public static final String MESSAGE_CODE = "PropertyNotFound";

  /**
   * The constructor.
   *
   * @param pojoType is the class reflecting the POJO.
   * @param propertyName is the name of the missing property.
   */
  public PojoPropertyNotFoundException(Class pojoType, String propertyName) {

    super(createBundle(NlsBundleUtilPojoRoot.class).errorPojoPropertyNotFound(propertyName, pojoType));
  }

  /**
   * The constructor.
   *
   * @param pojoType is the class reflecting the POJO.
   * @param propertyName is the name of the missing property.
   * @param mode is the access-mode for which the property is NOT available.
   */
  public PojoPropertyNotFoundException(Class pojoType, String propertyName, PojoPropertyAccessorMode mode) {

    super(createBundle(NlsBundleUtilPojoRoot.class).errorPojoPropertyNotAccessible(propertyName, pojoType, mode));
  }

  @Override
  public String getCode() {

    return MESSAGE_CODE;
  }

}