////////////////////////////////////////////////////////////////////////////////

 // checkstyle: Checks Java source code for adherence to a set of rules.

 // Copyright (C) 2001-2014  Oliver Burn

 //

 // This library is free software; you can redistribute it and/or

 // modify it under the terms of the GNU Lesser General Public

 // License as published by the Free Software Foundation; either

 // version 2.1 of the License, or (at your option) any later version.

 //

 // This library is distributed in the hope that it will be useful,

 // but WITHOUT ANY WARRANTY; without even the implied warranty of

 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 // Lesser General Public License for more details.

 //

 // You should have received a copy of the GNU Lesser General Public

 // License along with this library; if not, write to the Free Software

 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 ////////////////////////////////////////////////////////////////////////////////

 package com.puppycrawl.tools.checkstyle.checks.javadoc;

 import com.puppycrawl.tools.checkstyle.api.Check;

 import com.puppycrawl.tools.checkstyle.api.DetailAST;

 import com.puppycrawl.tools.checkstyle.api.FileContents;

 import com.puppycrawl.tools.checkstyle.api.Scope;

 import com.puppycrawl.tools.checkstyle.api.ScopeUtils;

 import com.puppycrawl.tools.checkstyle.api.TextBlock;

 import com.puppycrawl.tools.checkstyle.api.TokenTypes;

 /**

  * Checks that a variable has Javadoc comment.

  *

  * @author Oliver Burn

  * @version 1.0

  */

 public class JavadocVariableCheck

     extends Check

 {

     /** the scope to check */

     private Scope mScope = Scope.PRIVATE;

     /** the visibility scope where Javadoc comments shouldn't be checked **/

     private Scope mExcludeScope;

     /**

      * Sets the scope to check.

      * @param aFrom string to get the scope from

      */

     public void setScope(String aFrom)

     {

         mScope = Scope.getInstance(aFrom);

     }

     /**

      * Set the excludeScope.

      * @param aScope a <code>String</code> value

      */

     public void setExcludeScope(String aScope)

     {

         mExcludeScope = Scope.getInstance(aScope);

     }

     @Override

     public int[] getDefaultTokens()

     {

         return new int[] {

             TokenTypes.VARIABLE_DEF,

             TokenTypes.ENUM_CONSTANT_DEF,

         };

     }

     @Override

     public void visitToken(DetailAST aAST)

     {

         if (shouldCheck(aAST)) {

             final FileContents contents = getFileContents();

             final TextBlock cmt =

                 contents.getJavadocBefore(aAST.getLineNo());

             if (cmt == null) {

                 log(aAST, "javadoc.missing");

             }

         }

     }

     /**

      * Whether we should check this node.

      * @param aAST a given node.

      * @return whether we should check a given node.

      */

     private boolean shouldCheck(final DetailAST aAST)

     {

         if (ScopeUtils.inCodeBlock(aAST)) {

             return false;

         }

         final Scope scope;

         if (aAST.getType() == TokenTypes.ENUM_CONSTANT_DEF) {

             scope = Scope.PUBLIC;

         }

         else {

             final DetailAST mods = aAST.findFirstToken(TokenTypes.MODIFIERS);

             final Scope declaredScope = ScopeUtils.getScopeFromMods(mods);

             scope =

                 ScopeUtils.inInterfaceOrAnnotationBlock(aAST)

                     ? Scope.PUBLIC : declaredScope;

         }

         final Scope surroundingScope = ScopeUtils.getSurroundingScope(aAST);

         return scope.isIn(mScope) && surroundingScope.isIn(mScope)

             && ((mExcludeScope == null)

                 || !scope.isIn(mExcludeScope)

                 || !surroundingScope.isIn(mExcludeScope));

     }

 }