1 /*

     2  * Copyright (c) 2004, 2007, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.

     8  *

     9  * This code is distributed in the hope that it will be useful, but WITHOUT

    10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    12  * version 2 for more details (a copy is included in the LICENSE file that

    13  * accompanied this code).

    14  *

    15  * You should have received a copy of the GNU General Public License version

    16  * 2 along with this work; if not, write to the Free Software Foundation,

    17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    18  *

    19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    20  * or visit www.oracle.com if you need additional information or have any

    21  * questions.

    22  */

    23 

    24 

    25 import com.sun.mirror.apt.*;

    26 import com.sun.mirror.declaration.*;

    27 import com.sun.mirror.type.*;

    28 import com.sun.mirror.util.*;

    29 

    30 import java.util.Collection;

    31 import java.util.Set;

    32 import java.util.Arrays;

    33 

    34 import static java.util.Collections.*;

    35 import static com.sun.mirror.util.DeclarationVisitors.*;

    36 

    37 /*

    38  * The processor of this factory verifies class members are returned

    39  * in source-code order.

    40  */

    41 public class MemberOrderApf implements AnnotationProcessorFactory {

    42     // Process any set of annotations

    43     private static final Collection<String> supportedAnnotations

    44         = unmodifiableCollection(Arrays.asList("*"));

    45 

    46     // No supported options

    47     private static final Collection<String> supportedOptions = emptySet();

    48 

    49     public Collection<String> supportedAnnotationTypes() {

    50         return supportedAnnotations;

    51     }

    52 

    53     public Collection<String> supportedOptions() {

    54         return supportedOptions;

    55     }

    56 

    57     public AnnotationProcessor getProcessorFor(

    58             Set<AnnotationTypeDeclaration> atds,

    59             AnnotationProcessorEnvironment env) {

    60         return new MemberOrderAp(env);

    61     }

    62 

    63     private static class MemberOrderAp implements AnnotationProcessor {

    64         private final AnnotationProcessorEnvironment env;

    65         MemberOrderAp(AnnotationProcessorEnvironment env) {

    66             this.env = env;

    67         }

    68 

    69         private void verifyOrder(Collection<? extends Declaration> decls) {

    70             int count = 0;

    71             for(Declaration decl: decls) {

    72                 VisitOrder order = decl.getAnnotation(VisitOrder.class);

    73                 if (order.value() <= count)

    74                     throw new RuntimeException("Out of order declarations");

    75                 count = order.value();

    76             }

    77         }

    78 

    79         public void process() {

    80             for(TypeDeclaration td: env.getSpecifiedTypeDeclarations()) {

    81                 verifyOrder(td.getFields());

    82                 verifyOrder(td.getMethods());

    83             }

    84         }

    85     }

    86 }