001/*
002 * Copyright (c) 2021, 2022, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package org.jdrupes.mdoclet.internal.doclets.toolkit.util;
027
028import com.sun.source.doctree.DocTree;
029
030import javax.lang.model.element.Element;
031
032import org.jdrupes.mdoclet.internal.doclets.toolkit.BaseConfiguration;
033
034import java.util.List;
035
036import static com.sun.source.doctree.DocTree.Kind.SINCE;
037
038/**
039 * Build list of all the packages, classes, constructors, fields and methods
040 * that were added in one of the releases specified by the {@code --since}
041 * option. The release names must exactly match the names used in the javadoc
042 * {@code @since} tags of the respective elements.
043 */
044public class NewAPIBuilder extends SummaryAPIListBuilder {
045
046    public final List<String> releases;
047
048    public NewAPIBuilder(BaseConfiguration configuration,
049            List<String> releases) {
050        super(configuration,
051            element -> isNewAPI(element, configuration.utils, releases));
052        this.releases = releases;
053        buildSummaryAPIInfo();
054    }
055
056    private static boolean isNewAPI(Element e, Utils utils,
057            List<String> releases) {
058        if (!utils.hasDocCommentTree(e)) {
059            return false;
060        }
061        List<? extends DocTree> since = utils.getBlockTags(e, SINCE);
062        if (since.isEmpty()) {
063            return false;
064        }
065        CommentHelper ch = utils.getCommentHelper(e);
066        return since.stream()
067            .anyMatch(tree -> releases.contains(ch.getBody(tree).toString()));
068    }
069}