1 /*
   2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3  *
   4  * This code is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License version 2 only, as
   6  * published by the Free Software Foundation.  Oracle designates this
   7  * particular file as subject to the "Classpath" exception as provided
   8  * by Oracle in the LICENSE file that accompanied this code.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  */
  24 
  25 /*
  26  * This file is available under and governed by the GNU General Public
  27  * License version 2 only, as published by the Free Software Foundation.
  28  * However, the following notice accompanied the original version of this
  29  * file:
  30  *
  31  * ASM: a very small and fast Java bytecode manipulation framework
  32  * Copyright (c) 2000-2011 INRIA, France Telecom
  33  * All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  * 1. Redistributions of source code must retain the above copyright
  39  *    notice, this list of conditions and the following disclaimer.
  40  * 2. Redistributions in binary form must reproduce the above copyright
  41  *    notice, this list of conditions and the following disclaimer in the
  42  *    documentation and/or other materials provided with the distribution.
  43  * 3. Neither the name of the copyright holders nor the names of its
  44  *    contributors may be used to endorse or promote products derived from
  45  *    this software without specific prior written permission.
  46  *
  47  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  48  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  49  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  50  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  51  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  52  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  53  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  54  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  55  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  56  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  57  * THE POSSIBILITY OF SUCH DAMAGE.
  58  */
  59 package jdk.internal.org.objectweb.asm.util;
  60 
  61 import jdk.internal.org.objectweb.asm.AnnotationVisitor;
  62 import jdk.internal.org.objectweb.asm.Opcodes;
  63 import jdk.internal.org.objectweb.asm.Type;
  64 
  65 /**
  66  * An {@link AnnotationVisitor} that checks that its methods are properly used.
  67  *
  68  * @author Eric Bruneton
  69  */
  70 public class CheckAnnotationAdapter extends AnnotationVisitor {
  71 
  72     private final boolean named;
  73 
  74     private boolean end;
  75 
  76     public CheckAnnotationAdapter(final AnnotationVisitor av) {
  77         this(av, true);
  78     }
  79 
  80     CheckAnnotationAdapter(final AnnotationVisitor av, final boolean named) {
  81         super(Opcodes.ASM5, av);
  82         this.named = named;
  83     }
  84 
  85     @Override
  86     public void visit(final String name, final Object value) {
  87         checkEnd();
  88         checkName(name);
  89         if (!(value instanceof Byte || value instanceof Boolean
  90                 || value instanceof Character || value instanceof Short
  91                 || value instanceof Integer || value instanceof Long
  92                 || value instanceof Float || value instanceof Double
  93                 || value instanceof String || value instanceof Type
  94                 || value instanceof byte[] || value instanceof boolean[]
  95                 || value instanceof char[] || value instanceof short[]
  96                 || value instanceof int[] || value instanceof long[]
  97                 || value instanceof float[] || value instanceof double[])) {
  98             throw new IllegalArgumentException("Invalid annotation value");
  99         }
 100         if (value instanceof Type) {
 101             int sort = ((Type) value).getSort();
 102             if (sort != Type.OBJECT && sort != Type.ARRAY) {
 103                 throw new IllegalArgumentException("Invalid annotation value");
 104             }
 105         }
 106         if (av != null) {
 107             av.visit(name, value);
 108         }
 109     }
 110 
 111     @Override
 112     public void visitEnum(final String name, final String desc,
 113             final String value) {
 114         checkEnd();
 115         checkName(name);
 116         CheckMethodAdapter.checkDesc(desc, false);
 117         if (value == null) {
 118             throw new IllegalArgumentException("Invalid enum value");
 119         }
 120         if (av != null) {
 121             av.visitEnum(name, desc, value);
 122         }
 123     }
 124 
 125     @Override
 126     public AnnotationVisitor visitAnnotation(final String name,
 127             final String desc) {
 128         checkEnd();
 129         checkName(name);
 130         CheckMethodAdapter.checkDesc(desc, false);
 131         return new CheckAnnotationAdapter(av == null ? null
 132                 : av.visitAnnotation(name, desc));
 133     }
 134 
 135     @Override
 136     public AnnotationVisitor visitArray(final String name) {
 137         checkEnd();
 138         checkName(name);
 139         return new CheckAnnotationAdapter(av == null ? null
 140                 : av.visitArray(name), false);
 141     }
 142 
 143     @Override
 144     public void visitEnd() {
 145         checkEnd();
 146         end = true;
 147         if (av != null) {
 148             av.visitEnd();
 149         }
 150     }
 151 
 152     private void checkEnd() {
 153         if (end) {
 154             throw new IllegalStateException(
 155                     "Cannot call a visit method after visitEnd has been called");
 156         }
 157     }
 158 
 159     private void checkName(final String name) {
 160         if (named && name == null) {
 161             throw new IllegalArgumentException(
 162                     "Annotation value name must not be null");
 163         }
 164     }
 165 }