com.android.icu4j.srcgen.TagMatchingDeclarations.java Source code

Introduction

Here is the source code for com.android.icu4j.srcgen.TagMatchingDeclarations.java

Source

/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.icu4j.srcgen;

import com.google.common.collect.Lists;
import com.google.currysrc.api.process.Context;
import com.google.currysrc.api.process.JavadocUtils;
import com.google.currysrc.api.process.Processor;
import com.google.currysrc.api.process.ast.BodyDeclarationLocator;
import com.google.currysrc.api.process.ast.StartPositionComparator;

import org.eclipse.jdt.core.dom.BodyDeclaration;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.dom.rewrite.ASTRewrite;

import java.util.Collections;
import java.util.List;

/**
 * Adds a javadoc tag to {@link BodyDeclaration}s that match a list of locators.
 */
public class TagMatchingDeclarations implements Processor {
    private final List<BodyDeclarationLocator> locatorList;
    private final String tagComment;

    public TagMatchingDeclarations(List<BodyDeclarationLocator> locatorList, String tagComment) {
        this.locatorList = locatorList;
        this.tagComment = tagComment;
    }

    @Override
    public void process(Context context, CompilationUnit cu) {
        List<BodyDeclaration> matchingNodes = Lists.newArrayList();
        // This is inefficient but it is very simple.
        for (BodyDeclarationLocator locator : locatorList) {
            BodyDeclaration bodyDeclaration = locator.find(cu);
            if (bodyDeclaration != null) {
                matchingNodes.add(bodyDeclaration);
            }
        }
        // Tackle nodes in reverse order to avoid messing up the ASTNode offsets.
        Collections.sort(matchingNodes, new StartPositionComparator());
        ASTRewrite rewrite = context.rewrite();
        for (BodyDeclaration bodyDeclaration : Lists.reverse(matchingNodes)) {
            JavadocUtils.addJavadocTag(rewrite, bodyDeclaration, tagComment);
        }
    }

    @Override
    public String toString() {
        return "TagDeclarations{" + "locatorList=" + locatorList + "tagComment=" + tagComment + '}';
    }
}