1f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 2f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 3f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 4f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * you may not use this file except in compliance with the License. 6f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * You may obtain a copy of the License at 7f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 8f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 10f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * See the License for the specific language governing permissions and 14f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * limitations under the License. 15f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 16f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 17f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpackage com.android.dx.rop.annotation; 18f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 19f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.rop.cst.CstType; 20f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.util.MutabilityControl; 21f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport java.util.Collection; 22f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport java.util.Collections; 23f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport java.util.Iterator; 24f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport java.util.TreeMap; 25f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 26f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/** 27f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * List of {@link Annotation} instances. 28f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 29de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiropublic final class Annotations extends MutabilityControl 30f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project implements Comparable<Annotations> { 3199409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project /** {@code non-null;} immutable empty instance */ 32f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public static final Annotations EMPTY = new Annotations(); 33f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 34f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project static { 35f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project EMPTY.setImmutable(); 36f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 37de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro 3899409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project /** {@code non-null;} map from types to annotations */ 39f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project private final TreeMap<CstType, Annotation> annotations; 40f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 41f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 42f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Constructs an immutable instance which is the combination of the 43f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * two given instances. The two instances must contain disjoint sets 44f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * of types. 45de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 4699409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param a1 {@code non-null;} an instance 4799409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param a2 {@code non-null;} the other instance 4899409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} the combination 49f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws IllegalArgumentException thrown if there is a duplicate type 50f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 51f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public static Annotations combine(Annotations a1, Annotations a2) { 52f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project Annotations result = new Annotations(); 53f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 54f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project result.addAll(a1); 55f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project result.addAll(a2); 56f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project result.setImmutable(); 57f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 58f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return result; 59f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 60de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro 61f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 62f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Constructs an immutable instance which is the combination of the 63f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * given instance with the given additional annotation. The latter's 64f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * type must not already appear in the former. 65de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 6699409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param annotations {@code non-null;} the instance to augment 6799409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param annotation {@code non-null;} the additional annotation 6899409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} the combination 69f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws IllegalArgumentException thrown if there is a duplicate type 70f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 71f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public static Annotations combine(Annotations annotations, 72f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project Annotation annotation) { 73f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project Annotations result = new Annotations(); 74f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 75f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project result.addAll(annotations); 76f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project result.add(annotation); 77f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project result.setImmutable(); 78f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 79f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return result; 80f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 81de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro 82f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 83f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Constructs an empty instance. 84f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 85f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public Annotations() { 86f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project annotations = new TreeMap<CstType, Annotation>(); 87f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 88f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 89f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 90f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project @Override 91f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int hashCode() { 92f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return annotations.hashCode(); 93f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 94f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 95f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 96f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project @Override 97f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public boolean equals(Object other) { 98f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (! (other instanceof Annotations)) { 99f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return false; 100f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 101f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 102f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project Annotations otherAnnotations = (Annotations) other; 103f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 104f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return annotations.equals(otherAnnotations.annotations); 105f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 106f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 107f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 108f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int compareTo(Annotations other) { 109f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project Iterator<Annotation> thisIter = annotations.values().iterator(); 110f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project Iterator<Annotation> otherIter = other.annotations.values().iterator(); 111f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 112f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project while (thisIter.hasNext() && otherIter.hasNext()) { 113f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project Annotation thisOne = thisIter.next(); 114f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project Annotation otherOne = otherIter.next(); 115f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 116f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project int result = thisOne.compareTo(otherOne); 117f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (result != 0) { 118f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return result; 119f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 120f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 121f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 122f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (thisIter.hasNext()) { 123f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return 1; 124f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } else if (otherIter.hasNext()) { 125f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return -1; 126f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 127f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 128f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return 0; 129f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 130f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 131f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 132f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public String toString() { 133f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project StringBuilder sb = new StringBuilder(); 134f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project boolean first = true; 135f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 136f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append("annotations{"); 137f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 138f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project for (Annotation a : annotations.values()) { 139f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (first) { 140f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project first = false; 141f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } else { 142f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append(", "); 143f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 144f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append(a.toHuman()); 145f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 146f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 147f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append("}"); 148f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return sb.toString(); 149f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 150de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro 151f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 152f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Gets the number of elements in this instance. 153de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 15499409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code >= 0;} the size 155f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 156f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int size() { 157f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return annotations.size(); 158f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 159f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 160f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 161f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Adds an element to this instance. There must not already be an 162f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * element of the same type. 163de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 16499409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param annotation {@code non-null;} the element to add 165f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws IllegalArgumentException thrown if there is a duplicate type 166f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 167f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void add(Annotation annotation) { 168f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project throwIfImmutable(); 169f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 170f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (annotation == null) { 171f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project throw new NullPointerException("annotation == null"); 172f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 173f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 174f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project CstType type = annotation.getType(); 175de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro 176f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (annotations.containsKey(type)) { 177f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project throw new IllegalArgumentException("duplicate type: " + 178f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project type.toHuman()); 179f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 180f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 181f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project annotations.put(type, annotation); 182f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 183f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 184f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 185f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Adds all of the elements of the given instance to this one. The 186f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * instances must not have any duplicate types. 187de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 18899409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param toAdd {@code non-null;} the annotations to add 189f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws IllegalArgumentException thrown if there is a duplicate type 190f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 191f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void addAll(Annotations toAdd) { 192f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project throwIfImmutable(); 193f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 194f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (toAdd == null) { 195f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project throw new NullPointerException("toAdd == null"); 196f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 197f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 198f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project for (Annotation a : toAdd.annotations.values()) { 199f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project add(a); 200f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 201f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 202f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 203f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 204f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Gets the set of annotations contained in this instance. The 205f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * result is always unmodifiable. 206de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 20799409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} the set of annotations 208f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 209f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public Collection<Annotation> getAnnotations() { 210f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return Collections.unmodifiableCollection(annotations.values()); 211f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 212f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 213