001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2017 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.naming;
021
022import com.puppycrawl.tools.checkstyle.api.DetailAST;
023import com.puppycrawl.tools.checkstyle.api.TokenTypes;
024
025/**
026 * Abstract class for checking a class member (field/method)'s name conforms to
027 * a format specified by the format property.
028 *
029 * <p>
030 * This class extends {@link AbstractNameCheck} with support for access level
031 * restrictions. This allows the check to be configured to be applied to one of
032 * the four Java access levels: {@code public}, {@code protected},
033 * {@code "package"}, and {@code private}.
034 * </p>
035 *
036 * <p>Level is configured using the following properties:
037 * <ol>
038 * <li>applyToPublic, default true;</li>
039 * <li>applyToProtected, default true;</li>
040 * <li>applyToPackage, default true;</li>
041 * <li>applyToPrivate, default true;</li>
042 * </ol>
043 *
044 *
045 * @author Rick Giles
046 */
047public abstract class AbstractAccessControlNameCheck
048    extends AbstractNameCheck {
049    /** If true, applies the check be public members. */
050    private boolean applyToPublic = true;
051
052    /** If true, applies the check be protected members. */
053    private boolean applyToProtected = true;
054
055    /** If true, applies the check be "package" members. */
056    private boolean applyToPackage = true;
057
058    /** If true, applies the check be private members. */
059    private boolean applyToPrivate = true;
060
061    /**
062     * Creates a new {@code AbstractAccessControlNameCheck} instance.
063     *
064     * @param format
065     *                format to check with
066     */
067    protected AbstractAccessControlNameCheck(String format) {
068        super(format);
069    }
070
071    @Override
072    protected boolean mustCheckName(DetailAST ast) {
073        return shouldCheckInScope(ast.findFirstToken(TokenTypes.MODIFIERS));
074    }
075
076    /**
077     * Should we check member with given modifiers.
078     *
079     * @param modifiers
080     *                modifiers of member to check.
081     * @return true if we should check such member.
082     */
083    protected boolean shouldCheckInScope(DetailAST modifiers) {
084        final boolean isPublic = modifiers
085                .findFirstToken(TokenTypes.LITERAL_PUBLIC) != null;
086        final boolean isProtected = modifiers
087                .findFirstToken(TokenTypes.LITERAL_PROTECTED) != null;
088        final boolean isPrivate = modifiers
089                .findFirstToken(TokenTypes.LITERAL_PRIVATE) != null;
090        final boolean isPackage = !(isPublic || isProtected || isPrivate);
091
092        return applyToPublic && isPublic
093                || applyToProtected && isProtected
094                || applyToPackage && isPackage
095                || applyToPrivate && isPrivate;
096    }
097
098    /**
099     * Sets whether we should apply the check to public members.
100     *
101     * @param applyTo new value of the property.
102     */
103    public void setApplyToPublic(boolean applyTo) {
104        applyToPublic = applyTo;
105    }
106
107    /**
108     * Sets whether we should apply the check to protected members.
109     *
110     * @param applyTo new value of the property.
111     */
112    public void setApplyToProtected(boolean applyTo) {
113        applyToProtected = applyTo;
114    }
115
116    /**
117     * Sets whether we should apply the check to package-private members.
118     *
119     * @param applyTo new value of the property.
120     */
121    public void setApplyToPackage(boolean applyTo) {
122        applyToPackage = applyTo;
123    }
124
125    /**
126     * Sets whether we should apply the check to private members.
127     *
128     * @param applyTo new value of the property.
129     */
130    public void setApplyToPrivate(boolean applyTo) {
131        applyToPrivate = applyTo;
132    }
133}