001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2018 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.checks.javadoc;
021
022import java.io.File;
023import java.io.IOException;
024import java.util.Set;
025import java.util.concurrent.ConcurrentHashMap;
026
027import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
028import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
029import com.puppycrawl.tools.checkstyle.api.FileText;
030
031/**
032 * Checks that all packages have a package documentation. See the documentation
033 * for more information.
034 */
035public class JavadocPackageCheck extends AbstractFileSetCheck {
036
037    /**
038     * A key is pointing to the warning message text in "messages.properties"
039     * file.
040     */
041    public static final String MSG_LEGACY_PACKAGE_HTML = "javadoc.legacyPackageHtml";
042
043    /**
044     * A key is pointing to the warning message text in "messages.properties"
045     * file.
046     */
047    public static final String MSG_PACKAGE_INFO = "javadoc.packageInfo";
048
049    /** The directories checked. */
050    private final Set<File> directoriesChecked = ConcurrentHashMap.newKeySet();
051
052    /** Indicates if allow legacy "package.html" file to be used. */
053    private boolean allowLegacy;
054
055    /**
056     * Creates a new instance.
057     */
058    public JavadocPackageCheck() {
059        // java, not html!
060        // The rule is: Every JAVA file should have a package.html sibling
061        setFileExtensions("java");
062    }
063
064    @Override
065    public void beginProcessing(String charset) {
066        super.beginProcessing(charset);
067        directoriesChecked.clear();
068    }
069
070    @Override
071    protected void processFiltered(File file, FileText fileText) throws CheckstyleException {
072        // Check if already processed directory
073        final File dir;
074        try {
075            dir = file.getCanonicalFile().getParentFile();
076        }
077        catch (IOException ex) {
078            throw new CheckstyleException(
079                    "Exception while getting canonical path to file " + file.getPath(), ex);
080        }
081        final boolean isDirChecked = !directoriesChecked.add(dir);
082        if (!isDirChecked) {
083            // Check for the preferred file.
084            final File packageInfo = new File(dir, "package-info.java");
085            final File packageHtml = new File(dir, "package.html");
086
087            if (packageInfo.exists()) {
088                if (packageHtml.exists()) {
089                    log(0, MSG_LEGACY_PACKAGE_HTML);
090                }
091            }
092            else if (!allowLegacy || !packageHtml.exists()) {
093                log(0, MSG_PACKAGE_INFO);
094            }
095        }
096    }
097
098    /**
099     * Indicates whether to allow support for the legacy <i>package.html</i>
100     * file.
101     * @param allowLegacy whether to allow support.
102     */
103    public void setAllowLegacy(boolean allowLegacy) {
104        this.allowLegacy = allowLegacy;
105    }
106
107}