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.JavadocUtils; 19 import com.google.currysrc.api.process.Reporter; 20 21 import org.eclipse.jdt.core.dom.Javadoc; 22 import org.eclipse.jdt.core.dom.rewrite.ASTRewrite; 23 24 /** 25 * Inserts tag text to the Javadoc for any Javadoc comment that matches 26 * {@link #mustTag(org.eclipse.jdt.core.dom.Javadoc)}. 27 */ 28 public abstract class BaseJavadocTagJavadoc extends BaseJavadocNodeScanner { 29 30 private final String tagText; 31 32 protected BaseJavadocTagJavadoc(String tagText) { 33 this.tagText = tagText; 34 } 35 36 @Override protected final void visit(Reporter reporter, Javadoc javadoc, ASTRewrite rewrite) { 37 if (mustTag(javadoc)) { 38 JavadocUtils.addJavadocTag(rewrite, javadoc, tagText); 39 } 40 } 41 42 protected abstract boolean mustTag(Javadoc node); 43 } 44
