mockit.external.asm.AnnotationVisitor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmockit Show documentation
JMockit is a Java toolkit for automated developer testing. It contains mocking/faking APIs and a code coverage tool, supporting both JUnit and TestNG. The mocking APIs allow all kinds of Java code, without testability restrictions, to be tested in isolation from selected dependencies.
There is a newer version: 1.49
Show newest version
/*
 * ASM: a very small and fast Java bytecode manipulation framework
 * Copyright (c) 2000-2011 INRIA, France Telecom
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */
package mockit.external.asm;

import javax.annotation.*;

/**
 * A visitor to visit a Java annotation. The methods of this class must be called in the following order:
 * ( visit | visitEnum | visitAnnotation | visitArray )* visitEnd.
 */
public abstract class AnnotationVisitor
{
   /**
    * Next annotation visitor. This field is used to store annotation lists.
    */
   @Nullable AnnotationWriter next;

   /**
    * Previous annotation visitor. This field is used to store annotation lists.
    */
   @Nullable AnnotationWriter prev;

   /**
    * Constructs a new {@link AnnotationVisitor}.
    */
   protected AnnotationVisitor() {}

   @Nonnegative
   protected abstract int getByteLength();

   /**
    * Visits a primitive value of the annotation.
    *
    * @param name  the value name.
    * @param value the actual value, whose type must be {@link Byte}, {@link Boolean}, {@link Character},
    *              {@link Short}, {@link Integer}, {@link Long}, {@link Float}, {@link Double}, {@link String} or
    *              {@link JavaType} or OBJECT or ARRAY sort. This value can also be an array of byte, boolean, short,
    *              char, int, long, float or double values (this is equivalent to using {@link #visitArray visitArray}
    *              and visiting each array element in turn, but is more convenient).
    */
   public void visit(@Nullable String name, @Nonnull Object value) {}

   /**
    * Visits an enumeration value of the annotation.
    *
    * @param name  the value name.
    * @param desc  the class descriptor of the enumeration class.
    * @param value the actual enumeration value.
    */
   public void visitEnum(@Nullable String name, @Nonnull String desc, @Nonnull String value) {}

   /**
    * Visits a nested annotation value of the annotation.
    *
    * @param name the value name.
    * @param desc the class descriptor of the nested annotation class.
    * @return a visitor to visit the actual nested annotation value, or null if this visitor is not interested
    * in visiting this nested annotation. The nested annotation value must be fully visited before calling
    * other methods on this annotation visitor.
    */
   @Nullable
   public AnnotationVisitor visitAnnotation(@Nullable String name, @Nonnull String desc) { return null; }

   /**
    * Visits an array value of the annotation. Note that arrays of primitive types (such as byte, boolean, short, char,
    * int, long, float or double) can be passed as value to {@link #visit visit}.
    * This is what {@link ClassReader} does.
    *
    * @param name the value name.
    * @return a visitor to visit the actual array value elements, or null if this visitor is not interested in
    * visiting these values. The 'name' parameters passed to the methods of this visitor are ignored.
    * All the array values must be visited before calling other methods on this annotation visitor.
    */
   @Nullable
   public AnnotationVisitor visitArray(@Nullable String name) { return null; }

   /**
    * Visits the end of the annotation.
    */
   public void visitEnd() {}

   /**
    * Returns the size of this annotation list.
    */
   @Nonnegative
   final int getSize() {
      int size = 0;
      AnnotationVisitor annotation = this;

      while (annotation != null) {
         size += annotation.getByteLength();
         annotation = annotation.next;
      }

      return size;
   }
}