src/share/classes/javax/lang/model/util/ElementFilter.java

Tue, 28 Dec 2010 15:54:52 -0800

author
ohair
date
Tue, 28 Dec 2010 15:54:52 -0800
changeset 798
4868a36f6fd8
parent 554
9d9f26857129
child 1357
c75be5bc5283
permissions
-rw-r--r--

6962318: Update copyright year
Reviewed-by: xdono

duke@1 1 /*
ohair@554 2 * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * questions.
duke@1 24 */
duke@1 25
duke@1 26 package javax.lang.model.util;
duke@1 27
duke@1 28 import java.lang.Iterable;
duke@1 29 import java.util.Collections;
duke@1 30 import java.util.Iterator;
duke@1 31 import java.util.List;
duke@1 32 import java.util.Set;
duke@1 33 import java.util.EnumSet;
duke@1 34 import java.util.ArrayList;
duke@1 35 import java.util.LinkedHashSet;
duke@1 36 import java.util.NoSuchElementException;
duke@1 37
duke@1 38 import javax.lang.model.element.*;
duke@1 39 import javax.lang.model.type.*;
duke@1 40
duke@1 41
duke@1 42 /**
duke@1 43 * Filters for selecting just the elements of interest from a
duke@1 44 * collection of elements. The returned sets and lists are new
duke@1 45 * collections and do use the argument as a backing store. The
duke@1 46 * methods in this class do not make any attempts to guard against
duke@1 47 * concurrent modifications of the arguments. The returned sets and
duke@1 48 * lists are mutable but unsafe for concurrent access. A returned set
duke@1 49 * has the same iteration order as the argument set to a method.
duke@1 50 *
duke@1 51 * <p>If iterables and sets containing {@code null} are passed as
duke@1 52 * arguments to methods in this class, a {@code NullPointerException}
duke@1 53 * will be thrown.
duke@1 54 *
duke@1 55 * <p>Note that a <i>static import</i> statement can make the text of
duke@1 56 * calls to the methods in this class more concise; for example:
duke@1 57 *
duke@1 58 * <blockquote><pre>
duke@1 59 * import static javax.lang.model.util.ElementFilter.*;
duke@1 60 * ...
duke@1 61 * {@code List<VariableElement>} fs = fieldsIn(someClass.getEnclosedElements());
duke@1 62 * </pre></blockquote>
duke@1 63 *
duke@1 64 * @author Joseph D. Darcy
duke@1 65 * @author Scott Seligman
duke@1 66 * @author Peter von der Ah&eacute;
duke@1 67 * @author Martin Buchholz
duke@1 68 * @since 1.6
duke@1 69 */
duke@1 70 public class ElementFilter {
duke@1 71 private ElementFilter() {} // Do not instantiate.
duke@1 72
duke@1 73 private static Set<ElementKind> CONSTRUCTOR_KIND =
duke@1 74 Collections.unmodifiableSet(EnumSet.of(ElementKind.CONSTRUCTOR));
duke@1 75
duke@1 76 private static Set<ElementKind> FIELD_KINDS =
duke@1 77 Collections.unmodifiableSet(EnumSet.of(ElementKind.FIELD,
duke@1 78 ElementKind.ENUM_CONSTANT));
duke@1 79 private static Set<ElementKind> METHOD_KIND =
duke@1 80 Collections.unmodifiableSet(EnumSet.of(ElementKind.METHOD));
duke@1 81
duke@1 82 private static Set<ElementKind> PACKAGE_KIND =
duke@1 83 Collections.unmodifiableSet(EnumSet.of(ElementKind.PACKAGE));
duke@1 84
duke@1 85 private static Set<ElementKind> TYPE_KINDS =
duke@1 86 Collections.unmodifiableSet(EnumSet.of(ElementKind.CLASS,
duke@1 87 ElementKind.ENUM,
duke@1 88 ElementKind.INTERFACE,
duke@1 89 ElementKind.ANNOTATION_TYPE));
duke@1 90 /**
duke@1 91 * Returns a list of fields in {@code elements}.
duke@1 92 * @return a list of fields in {@code elements}
duke@1 93 * @param elements the elements to filter
duke@1 94 */
duke@1 95 public static List<VariableElement>
duke@1 96 fieldsIn(Iterable<? extends Element> elements) {
duke@1 97 return listFilter(elements, FIELD_KINDS, VariableElement.class);
duke@1 98 }
duke@1 99
duke@1 100 /**
duke@1 101 * Returns a set of fields in {@code elements}.
duke@1 102 * @return a set of fields in {@code elements}
duke@1 103 * @param elements the elements to filter
duke@1 104 */
duke@1 105 public static Set<VariableElement>
duke@1 106 fieldsIn(Set<? extends Element> elements) {
duke@1 107 return setFilter(elements, FIELD_KINDS, VariableElement.class);
duke@1 108 }
duke@1 109
duke@1 110 /**
duke@1 111 * Returns a list of constructors in {@code elements}.
duke@1 112 * @return a list of constructors in {@code elements}
duke@1 113 * @param elements the elements to filter
duke@1 114 */
duke@1 115 public static List<ExecutableElement>
duke@1 116 constructorsIn(Iterable<? extends Element> elements) {
duke@1 117 return listFilter(elements, CONSTRUCTOR_KIND, ExecutableElement.class);
duke@1 118 }
duke@1 119
duke@1 120 /**
duke@1 121 * Returns a set of constructors in {@code elements}.
duke@1 122 * @return a set of constructors in {@code elements}
duke@1 123 * @param elements the elements to filter
duke@1 124 */
duke@1 125 public static Set<ExecutableElement>
duke@1 126 constructorsIn(Set<? extends Element> elements) {
duke@1 127 return setFilter(elements, CONSTRUCTOR_KIND, ExecutableElement.class);
duke@1 128 }
duke@1 129
duke@1 130 /**
duke@1 131 * Returns a list of methods in {@code elements}.
duke@1 132 * @return a list of methods in {@code elements}
duke@1 133 * @param elements the elements to filter
duke@1 134 */
duke@1 135 public static List<ExecutableElement>
duke@1 136 methodsIn(Iterable<? extends Element> elements) {
duke@1 137 return listFilter(elements, METHOD_KIND, ExecutableElement.class);
duke@1 138 }
duke@1 139
duke@1 140 /**
duke@1 141 * Returns a set of methods in {@code elements}.
duke@1 142 * @return a set of methods in {@code elements}
duke@1 143 * @param elements the elements to filter
duke@1 144 */
duke@1 145 public static Set<ExecutableElement>
duke@1 146 methodsIn(Set<? extends Element> elements) {
duke@1 147 return setFilter(elements, METHOD_KIND, ExecutableElement.class);
duke@1 148 }
duke@1 149
duke@1 150 /**
duke@1 151 * Returns a list of types in {@code elements}.
duke@1 152 * @return a list of types in {@code elements}
duke@1 153 * @param elements the elements to filter
duke@1 154 */
duke@1 155 public static List<TypeElement>
duke@1 156 typesIn(Iterable<? extends Element> elements) {
duke@1 157 return listFilter(elements, TYPE_KINDS, TypeElement.class);
duke@1 158 }
duke@1 159
duke@1 160 /**
duke@1 161 * Returns a set of types in {@code elements}.
duke@1 162 * @return a set of types in {@code elements}
duke@1 163 * @param elements the elements to filter
duke@1 164 */
duke@1 165 public static Set<TypeElement>
duke@1 166 typesIn(Set<? extends Element> elements) {
duke@1 167 return setFilter(elements, TYPE_KINDS, TypeElement.class);
duke@1 168 }
duke@1 169
duke@1 170 /**
duke@1 171 * Returns a list of packages in {@code elements}.
duke@1 172 * @return a list of packages in {@code elements}
duke@1 173 * @param elements the elements to filter
duke@1 174 */
duke@1 175 public static List<PackageElement>
duke@1 176 packagesIn(Iterable<? extends Element> elements) {
duke@1 177 return listFilter(elements, PACKAGE_KIND, PackageElement.class);
duke@1 178 }
duke@1 179
duke@1 180 /**
duke@1 181 * Returns a set of packages in {@code elements}.
duke@1 182 * @return a set of packages in {@code elements}
duke@1 183 * @param elements the elements to filter
duke@1 184 */
duke@1 185 public static Set<PackageElement>
duke@1 186 packagesIn(Set<? extends Element> elements) {
duke@1 187 return setFilter(elements, PACKAGE_KIND, PackageElement.class);
duke@1 188 }
duke@1 189
duke@1 190 // Assumes targetKinds and E are sensible.
duke@1 191 private static <E extends Element> List<E> listFilter(Iterable<? extends Element> elements,
duke@1 192 Set<ElementKind> targetKinds,
duke@1 193 Class<E> clazz) {
duke@1 194 List<E> list = new ArrayList<E>();
duke@1 195 for (Element e : elements) {
duke@1 196 if (targetKinds.contains(e.getKind()))
duke@1 197 list.add(clazz.cast(e));
duke@1 198 }
duke@1 199 return list;
duke@1 200 }
duke@1 201
duke@1 202 // Assumes targetKinds and E are sensible.
duke@1 203 private static <E extends Element> Set<E> setFilter(Set<? extends Element> elements,
duke@1 204 Set<ElementKind> targetKinds,
duke@1 205 Class<E> clazz) {
duke@1 206 // Return set preserving iteration order of input set.
duke@1 207 Set<E> set = new LinkedHashSet<E>();
duke@1 208 for (Element e : elements) {
duke@1 209 if (targetKinds.contains(e.getKind()))
duke@1 210 set.add(clazz.cast(e));
duke@1 211 }
duke@1 212 return set;
duke@1 213 }
duke@1 214 }

mercurial