0N/A/*
553N/A * Copyright (c) 2004, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
553N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
553N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
553N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
553N/A * or visit www.oracle.com if you need additional information or have any
553N/A * questions.
0N/A */
0N/A
0N/Apackage com.sun.mirror.util;
0N/A
0N/A/**
0N/A * Utilities to create specialized <tt>DeclarationVisitor</tt> instances.
0N/A *
330N/A * @deprecated All components of this API have been superseded by the
330N/A * standardized annotation processing API. There is no direct
330N/A * replacement for the functionality of this class in the standardized
330N/A * API due to that API's different visitor structure.
330N/A *
0N/A * @author Joseph D. Darcy
0N/A * @author Scott Seligman
0N/A * @since 1.5
0N/A */
330N/A@Deprecated
330N/A@SuppressWarnings("deprecation")
0N/Apublic class DeclarationVisitors {
0N/A private DeclarationVisitors(){} // do not instantiate.
0N/A
0N/A /**
0N/A * A visitor that has no side effects and keeps no state.
0N/A */
0N/A public static final DeclarationVisitor NO_OP = new SimpleDeclarationVisitor();
0N/A
0N/A /**
0N/A * Return a <tt>DeclarationVisitor</tt> that will scan the
0N/A * declaration structure, visiting declarations contained in
0N/A * another declaration. For example, when visiting a class, the
0N/A * fields, methods, constructors, etc. of the class are also
0N/A * visited. The order in which the contained declarations are scanned is
0N/A * not specified.
0N/A *
0N/A * <p>The <tt>pre</tt> and <tt>post</tt>
0N/A * <tt>DeclarationVisitor</tt> parameters specify,
0N/A * respectively, the processing the scanner will do before or
0N/A * after visiting the contained declarations. If only one of pre
0N/A * and post processing is needed, use {@link
0N/A * DeclarationVisitors#NO_OP DeclarationVisitors.NO_OP} for the
0N/A * other parameter.
0N/A *
0N/A * @param pre visitor representing processing to do before
0N/A * visiting contained declarations.
0N/A *
0N/A * @param post visitor representing processing to do after
0N/A * visiting contained declarations.
0N/A */
0N/A public static DeclarationVisitor getDeclarationScanner(DeclarationVisitor pre,
0N/A DeclarationVisitor post) {
0N/A return new DeclarationScanner(pre, post);
0N/A }
0N/A
0N/A /**
0N/A * Return a <tt>DeclarationVisitor</tt> that will scan the
0N/A * declaration structure, visiting declarations contained in
0N/A * another declaration in source code order. For example, when
0N/A * visiting a class, the fields, methods, constructors, etc. of
0N/A * the class are also visited. The order in which the contained
0N/A * declarations are visited is as close to source code order as
0N/A * possible; declaration mirrors created from class files instead
0N/A * of source code will not have source position information.
0N/A *
0N/A * <p>The <tt>pre</tt> and <tt>post</tt>
0N/A * <tt>DeclarationVisitor</tt> parameters specify,
0N/A * respectively, the processing the scanner will do before or
0N/A * after visiting the contained declarations. If only one of pre
0N/A * and post processing is needed, use {@link
0N/A * DeclarationVisitors#NO_OP DeclarationVisitors.NO_OP} for the other parameter.
0N/A *
0N/A * @param pre visitor representing processing to do before
0N/A * visiting contained declarations.
0N/A *
0N/A * @param post visitor representing processing to do after
0N/A * visiting contained declarations.
0N/A */
0N/A public static DeclarationVisitor getSourceOrderDeclarationScanner(DeclarationVisitor pre,
0N/A DeclarationVisitor post) {
0N/A return new SourceOrderDeclScanner(pre, post);
0N/A }
0N/A}