Coverage Report - com.puppycrawl.tools.checkstyle.api.Scope
 
Classes in this File Line Coverage Branch Coverage Complexity
Scope
100%
11/11
100%
2/2
1
 
 1  
 ////////////////////////////////////////////////////////////////////////////////
 2  
 // checkstyle: Checks Java source code for adherence to a set of rules.
 3  
 // Copyright (C) 2001-2017 the original author or authors.
 4  
 //
 5  
 // This library is free software; you can redistribute it and/or
 6  
 // modify it under the terms of the GNU Lesser General Public
 7  
 // License as published by the Free Software Foundation; either
 8  
 // version 2.1 of the License, or (at your option) any later version.
 9  
 //
 10  
 // This library is distributed in the hope that it will be useful,
 11  
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 12  
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 13  
 // Lesser General Public License for more details.
 14  
 //
 15  
 // You should have received a copy of the GNU Lesser General Public
 16  
 // License along with this library; if not, write to the Free Software
 17  
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 18  
 ////////////////////////////////////////////////////////////////////////////////
 19  
 
 20  
 package com.puppycrawl.tools.checkstyle.api;
 21  
 
 22  
 import java.util.Locale;
 23  
 
 24  
 /**
 25  
  * Represents a Java visibility scope.
 26  
  *
 27  
  * @author Lars Kühne
 28  
  * @author Travis Schneeberger
 29  
  * @author Mehmet Can Cömert
 30  
  */
 31  17
 public enum Scope {
 32  
     /** Nothing scope. */
 33  2
     NOTHING,
 34  
     /** Public scope. */
 35  2
     PUBLIC,
 36  
     /** Protected scope. */
 37  2
     PROTECTED,
 38  
     /** Package or default scope. */
 39  2
     PACKAGE,
 40  
     /** Private scope. */
 41  2
     PRIVATE,
 42  
     /** Anonymous inner scope. */
 43  2
     ANONINNER;
 44  
 
 45  
     @Override
 46  
     public String toString() {
 47  6
         return getName();
 48  
     }
 49  
 
 50  
     /**
 51  
      * Returns name of severity level.
 52  
      * @return the name of this severity level.
 53  
      */
 54  
     public String getName() {
 55  28
         return name().toLowerCase(Locale.ENGLISH);
 56  
     }
 57  
 
 58  
     /**
 59  
      * Checks if this scope is a subscope of another scope.
 60  
      * Example: PUBLIC is a subscope of PRIVATE.
 61  
      *
 62  
      * @param scope a {@code Scope} value
 63  
      * @return if {@code this} is a subscope of {@code scope}.
 64  
      */
 65  
     public boolean isIn(Scope scope) {
 66  3560
         return compareTo(scope) <= 0;
 67  
     }
 68  
 
 69  
     /**
 70  
      * Scope factory method.
 71  
      *
 72  
      * @param scopeName scope name, such as "nothing", "public", etc.
 73  
      * @return the {@code Scope} associated with {@code scopeName}
 74  
      */
 75  
     public static Scope getInstance(String scopeName) {
 76  55
         return valueOf(Scope.class, scopeName.trim().toUpperCase(Locale.ENGLISH));
 77  
     }
 78  
 }