net.sf.mmm.util.pojo.path.api.IllegalPojoPathException 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.

There is a newer version: 8.7.0

/* 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.path.api;

import net.sf.mmm.util.pojo.NlsBundleUtilPojoRoot;

/**
 * An {@link IllegalPojoPathException} is thrown by the {@link PojoPathNavigator} if the supplied {@link PojoPath} is
 * illegal. 

 * Here are some examples of illegal POJO-paths:
 * 
 * {@code null}
 * {@code ""}
 * {@code "."}
 * {@code ".foo"}
 * {@code "bar."}
 * 
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.1.0
 */
public class IllegalPojoPathException extends PojoPathException {

  private static final long serialVersionUID = -221363144035352042L;

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

  /**
   * The constructor.
   *
   * @param pojoPath is the {@link PojoPath} that is illegal.
   */
  public IllegalPojoPathException(String pojoPath) {

    this(null, pojoPath);
  }

  /**
   * The constructor.
   *
   * @param nested is the {@link #getCause() cause} of this exception.
   * @param pojoPath is the {@link PojoPath} that is illegal.
   */
  public IllegalPojoPathException(Throwable nested, String pojoPath) {

    super(nested, createBundle(NlsBundleUtilPojoRoot.class).errorPojoPathIllegal(pojoPath));
  }

  @Override
  public String getCode() {

    return MESSAGE_CODE;
  }

}