All Downloads are FREE. Search and download functionalities are using the official Maven repository.

soot.util.annotations.AnnotationInstanceCreator Maven / Gradle / Ivy

package soot.util.annotations;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 1997 - 2018 Raja Vallée-Rai and others
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 2.1 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import com.google.common.reflect.AbstractInvocationHandler;

import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

import soot.tagkit.AnnotationElem;
import soot.tagkit.AnnotationEnumElem;
import soot.tagkit.AnnotationTag;
import soot.util.annotations.AnnotationElemSwitch.AnnotationElemResult;

/**
 *
 * A simple helper class with the ability to create an instance of {@link Proxy} implementing the annotation interface
 * represented by the given {@link AnnotationTag}.
 *
 *
 * @author Florian Kuebler
 *
 */
public class AnnotationInstanceCreator {

  /**
   * Creates an instance of the Annotation represented by tag.
   *
   * @param tag
   *          the soot internal representation of the annotation to be created.
   * @return an Object extending {@link Proxy} and implementing the type of tag
   * @throws RuntimeException
   *           if
   *           
    *
  • the class defined in {@link AnnotationTag#getType()} of tag could not be loaded.
  • * *
  • tag does not define all required methods of the annotation loaded.
  • * *
  • a class defined within a {@link AnnotationElem} could not be loaded.
  • * *
  • the enum defined in {@link AnnotationEnumElem} is no instance of {@link Enum}.
  • *
*/ public Object create(AnnotationTag tag) { ClassLoader cl = this.getClass().getClassLoader(); try { // load the class of the annotation to be created final Class clazz = ClassLoaderUtils.loadClass(tag.getType().replace('/', '.')); final Map map = new HashMap(); // for every element generate the result for (AnnotationElem elem : tag.getElems()) { AnnotationElemSwitch sw = new AnnotationElemSwitch(); elem.apply(sw); @SuppressWarnings("unchecked") AnnotationElemResult result = (AnnotationElemResult) sw.getResult(); map.put(result.getKey(), result.getValue()); } // create the instance Object result = Proxy.newProxyInstance(cl, new Class[] { clazz }, new AbstractInvocationHandler() { @SuppressWarnings("unchecked") @Override protected Object handleInvocation(Object proxy, Method method, Object[] args) throws Throwable { String name = method.getName(); Class retType = method.getReturnType(); // if the method being called is #annotationType return the // clazz of the annotation if (name.equals("annotationType")) { return clazz; } // get the precomputed result for the method being called. Object result = map.get(name); if (result != null) { // if the result is an Object[], the array has to be // transformed to an array of the return type. if (result instanceof Object[]) { Object[] oa = (Object[]) result; return Arrays.copyOf(oa, oa.length, (Class) retType); } // java bytecode does not know boolean types. if ((retType.equals(boolean.class) || retType.equals(Boolean.class)) && (result instanceof Integer)) { return ((Integer) result) != 0; } return result; } else { // if the AnnotationTag does not define a method, try to // use the default value. result = method.getDefaultValue(); if (result != null) { return result; } } throw new RuntimeException("No value for " + name + " declared in the annotation " + clazz); } }); return result; } catch (ClassNotFoundException e) { throw new RuntimeException("Could not load class: " + tag.getType()); } } }