AbstractClassNameCheck (checkstyle 6.15 API)

java.lang.Object
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
- - com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
  - - com.puppycrawl.tools.checkstyle.api.Check
    - - com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck

All Implemented Interfaces:

Configurable, Contextualizable
```
public final class AbstractClassNameCheck
extends Check
```
Ensures that the names of abstract classes conforming to some regular expression and check that abstract modifier exists.

Rationale: Abstract classes are convenience base class implementations of interfaces, not types as such. As such they should be named to indicate this. Also if names of classes starts with 'Abstract' it's very convenient that they will have abstract modifier.

Author:

Simon Harris, Danil Lopatin

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`MSG_ILLEGAL_ABSTRACT_CLASS_NAME` A key is pointing to the warning message text in "messages.properties" file.
`static String`	`MSG_NO_ABSTRACT_CLASS_MODIFIER` A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors
Constructor and Description

AbstractClassNameCheck()

Constructors
Constructor and Description
`AbstractClassNameCheck()`

Method Summary

Methods
Modifier and Type	Method and Description
`int[]`	`getAcceptableTokens()` The configurable token set.
`int[]`	`getDefaultTokens()` Returns the default token a check is interested in.
`int[]`	`getRequiredTokens()` The tokens that this check must be registered for.
`void`	`setFormat(String format)` Set the format to the specified regular expression.
`void`	`setIgnoreModifier(boolean value)` Whether to ignore checking for the `abstract` modifier.
`void`	`setIgnoreName(boolean value)` Whether to ignore checking the name.
`void`	`visitToken(DetailAST ast)` Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MSG_ILLEGAL_ABSTRACT_CLASS_NAME
```
public static final String MSG_ILLEGAL_ABSTRACT_CLASS_NAME
```
    A key is pointing to the warning message text in "messages.properties" file.
    
    See Also:
    Constant Field Values
  - MSG_NO_ABSTRACT_CLASS_MODIFIER
```
public static final String MSG_NO_ABSTRACT_CLASS_MODIFIER
```
    A key is pointing to the warning message text in "messages.properties" file.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - AbstractClassNameCheck
```
public AbstractClassNameCheck()
```
- Method Detail
  - setIgnoreModifier
```
public void setIgnoreModifier(boolean value)
```
    Whether to ignore checking for the abstract modifier.
    
    Parameters:
    value - new value
  - setIgnoreName
```
public void setIgnoreName(boolean value)
```
    Whether to ignore checking the name.
    
    Parameters:
    value - new value.
  - setFormat
```
public void setFormat(String format)
```
    Set the format to the specified regular expression.
    
    Parameters:
    format - a String value
    
    Throws:
    
    org.apache.commons.beanutils.ConversionException - unable to parse format
  - getDefaultTokens
```
public int[] getDefaultTokens()
```
    Description copied from class: Check
    
    Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
    
    Specified by:
    
    getDefaultTokens in class Check
    
    Returns:
    the default tokens
    See Also:
    TokenTypes
  - getRequiredTokens
```
public int[] getRequiredTokens()
```
    Description copied from class: Check
    
    The tokens that this check must be registered for.
    
    Overrides:
    
    getRequiredTokens in class Check
    
    Returns:
    the token set this must be registered for.
    See Also:
    TokenTypes
  - getAcceptableTokens
```
public int[] getAcceptableTokens()
```
    Description copied from class: Check
    
    The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.
    
    Overrides:
    
    getAcceptableTokens in class Check
    
    Returns:
    the token set this check is designed for.
    See Also:
    TokenTypes
  - visitToken
```
public void visitToken(DetailAST ast)
```
    Description copied from class: Check
    
    Called to process a token.
    
    Overrides:
    
    visitToken in class Check
    
    Parameters:
    ast - the token to process

Class AbstractClassNameCheck

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

Methods inherited from class java.lang.Object

Field Detail

MSG_ILLEGAL_ABSTRACT_CLASS_NAME

MSG_NO_ABSTRACT_CLASS_MODIFIER

Constructor Detail

AbstractClassNameCheck

Method Detail

setIgnoreModifier

setIgnoreName

setFormat

getDefaultTokens

getRequiredTokens

getAcceptableTokens

visitToken