Home | History | Annotate | Download | only in processors
      1 /*
      2  * Copyright (C) 2015 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 package com.google.currysrc.processors;
     17 
     18 import com.google.currysrc.api.process.Reporter;
     19 
     20 import org.eclipse.jdt.core.dom.ASTVisitor;
     21 import org.eclipse.jdt.core.dom.Javadoc;
     22 import org.eclipse.jdt.core.dom.TagElement;
     23 import org.eclipse.jdt.core.dom.rewrite.ASTRewrite;
     24 
     25 /**
     26  * A base-class for scanners that might modify {@link TagElement} nodes within Javadoc.
     27  */
     28 public abstract class BaseTagElementNodeScanner extends BaseJavadocNodeScanner {
     29 
     30   @Override protected final void visit(final Reporter reporter, Javadoc javadoc,
     31       final ASTRewrite rewrite) {
     32 
     33     javadoc.accept(new ASTVisitor(true /* visitDocTags */) {
     34       @Override public boolean visit(TagElement node) {
     35         return visitTagElement(reporter, rewrite, node);
     36       }
     37     });
     38   }
     39 
     40   protected abstract boolean visitTagElement(Reporter reporter, ASTRewrite rewrite, TagElement tag);
     41 }
     42