001/* AnnotationFormatError.java - Thrown when an binary annotation is malformed
002   Copyright (C) 2004, 2005 Free Software Foundation
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package java.lang.annotation;
039
040/**
041 * Thrown when an annotation found in a class file is
042 * malformed.  When the virtual machine finds a class file
043 * containing annotations, it attempts to parse them.
044 * This error is thrown if this operation fails.
045 *
046 * @author Tom Tromey (tromey@redhat.com)
047 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
048 * @since 1.5
049 */
050public class AnnotationFormatError extends Error
051{
052  private static final long serialVersionUID = -4256701562333669892L;
053
054  /**
055   * Constructs a new <code>AnnotationFormatError</code>
056   * using the specified message to give details of the error.
057   *
058   * @param message the message to use in the error output.
059   */
060  public AnnotationFormatError(String message)
061  {
062    super(message);
063  }
064
065  /**
066   * <p>
067   * Constructs a new <code>AnnotationFormatError</code>
068   * using the specified message to give details of the error.
069   * The supplied cause <code>Throwable</code> is used to
070   * provide additional history, with regards to the root
071   * of the problem.  It is perfectly valid for this to be null, if
072   * the cause is unknown.
073   * </p>
074   * <p>
075   * <strong>Note</strong>: if a cause is supplied, the error
076   * message from this cause is not automatically included in the
077   * error message given by this error.
078   * </p>
079   *
080   * @param message the message to use in the error output
081   * @param cause the cause of this error, or null if the cause
082   *              is unknown.
083   */
084  public AnnotationFormatError(String message, Throwable cause)
085  {
086    super(message, cause);
087  }
088
089  /**
090   * Constructs a new <code>AnnotationFormatError</code> using
091   * the supplied cause <code>Throwable</code> to
092   * provide additional history, with regards to the root
093   * of the problem.  It is perfectly valid for this to be null, if
094   * the cause is unknown.  If the cause is not null, the error
095   * message from this cause will also be used as the message
096   * for this error.
097   *
098   * @param cause the cause of the error.
099   */
100  public AnnotationFormatError(Throwable cause)
101  {
102    super(cause);
103  }
104
105}