soot.tagkit.AnnotationTag Maven / Gradle / Ivy

package soot.tagkit;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 2005 Jennifer Lhotak
 * Copyright (C) 2013 Tata Consultancy Services & Ecole Polytechnique de Montreal
 * %%
 * 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 java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

/**
 * Represents the annotation attribute attached to a class, method, field, method param - they could have many annotations
 * each for Java 1.5.
 */

public class AnnotationTag implements Tag {

  // type - the question here is the class of the type is potentially
  // not loaded -- Does it need to be ??? - If it does then this may
  // be something difficult (if just passing the attributes through
  // then it maybe doesn't need to - but if they are runtime visible
  // attributes then won't the annotation class need to be created
  // in the set of output classes for use by tools when using
  // reflection ???

  // number of elem value pairs
  // a bunch of element value pairs
  // a type B C D F I J S Z s e c @ [
  // for B C D F I J S Z s elem is a constant value (entry to cp)
  // in Soot rep as
  // for e elem is a type and the simple name of the enum class
  // rep in Soot as a type and SootClass or as two strings
  // for c elem is a descriptor of the class represented
  // rep in Soot as a SootClass ?? or a string ??
  // for @ (nested annotation)
  // for [ elem is num values and array of values
  // should probably make a bunch of subclasses for all the
  // different kinds - with second level for the constant kinds

  /**
   * The type
   */
  private String type;

  /**
   * The annotations
   */
  private List elems;

  public AnnotationTag(String type) {
    this.type = type;
    this.elems = null;
  }

  public AnnotationTag(String type, Collection elements) {
    this.type = type;

    if (elements == null || elements.isEmpty()) {
      this.elems = null;
    } else if (elements instanceof List) {
      this.elems = (List) elements;
    } else {
      this.elems = new ArrayList(elements);
    }
  }

  @Deprecated
  public AnnotationTag(String type, int numElem) {
    this.type = type;
    this.elems = new ArrayList(numElem);
  }

  // should also print here number of annotations and perhaps the annotations themselves
  public String toString() {
    if (elems != null) {
      StringBuffer sb = new StringBuffer("Annotation: type: " + type + " num elems: " + elems.size() + " elems: ");
      Iterator it = elems.iterator();
      while (it.hasNext()) {
        sb.append("\n");
        sb.append(it.next());
      }
      sb.append("\n");
      return sb.toString();
    } else {
      return "Annotation type: " + type + " without elements";
    }
  }

  /** Returns the tag name. */
  public String getName() {
    return "AnnotationTag";
  }

  public String getInfo() {
    return "Annotation";
  }

  public String getType() {
    return type;
  }

  /** Returns the tag raw data. */
  public byte[] getValue() {
    throw new RuntimeException("AnnotationTag has no value for bytecode");
  }

  /**
   * Adds one element to the list
   *
   * @param elem
   *          the element
   */
  public void addElem(AnnotationElem elem) {
    if (elems == null) {
      elems = new ArrayList();
    }
    elems.add(elem);
  }

  /**
   * Overwrites the elements stored previously
   *
   * @param list
   *          the new list of elements
   */
  public void setElems(List list) {
    this.elems = list;
  }

  /**
   * @return an immutable collection of the elements
   */
  public Collection getElems() {
    return elems == null ? Collections.emptyList() : Collections.unmodifiableCollection(elems);
  }
}