KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > j2ee > jpa > verification > common > RulesEngine


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.modules.j2ee.jpa.verification.common;
21
22 import java.util.ArrayList JavaDoc;
23 import java.util.Collection JavaDoc;
24 import java.util.List JavaDoc;
25 import javax.lang.model.element.TypeElement;
26 import javax.lang.model.util.ElementFilter;
27 import javax.lang.model.util.ElementKindVisitor6;
28 import org.netbeans.spi.editor.hints.ErrorDescription;
29
30 /**
31  *
32  * @author Tomasz.Slota@Sun.COM
33  */
34 public abstract class RulesEngine extends ElementKindVisitor6<Void JavaDoc, ProblemContext> {
35     private ProblemContext ctx;
36     private List JavaDoc<ErrorDescription> problemsFound = new ArrayList JavaDoc<ErrorDescription>();
37     
38     @Override JavaDoc public Void JavaDoc visitTypeAsClass(TypeElement javaClass, ProblemContext ctx){
39         // visit all enclosed classes recursively
40 for (TypeElement enclosedClass : ElementFilter.typesIn(javaClass.getEnclosedElements())){
41             visitTypeAsClass(enclosedClass, ctx);
42         }
43         
44         // apply class-level rules
45 for (Rule<TypeElement> rule : getClassRules()){
46             if (ctx.isCancelled()){
47                 break;
48             }
49             
50             ErrorDescription problems[] = rule.execute(javaClass, ctx);
51             
52             if (problems != null){
53                 for (ErrorDescription problem : problems){
54                     if (problem != null){
55                         problemsFound.add(problem);
56                     }
57                 }
58             }
59         }
60         
61         return null;
62     }
63     
64     public List JavaDoc<ErrorDescription> getProblemsFound(){
65         return problemsFound;
66     }
67     
68     protected abstract Collection JavaDoc<Rule<TypeElement>> getClassRules();
69 }
70
Popular Tags