Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ design overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.puppycrawl.tools.checkstyle.checks.design
Class FinalClassCheck  

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.design.FinalClassCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

---

public class FinalClassCheck

extends com.puppycrawl.tools.checkstyle.api.Check

Checks that class which has only private ctors is declared as final.

An example of how to configure the check is:

 <module name="FinalClass"/>
 

---

Nested Class Summary
private static class	FinalClassCheck.ClassDesc           maintains information about class' ctors

 

Field Summary
private  java.util.Stack	mClasses           keeps ClassDesc objects for stack of declared classes

 

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

 

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

 

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

 

Constructor Summary

FinalClassCheck()

 

Method Summary
int[]	getDefaultTokens()           Returns the default token a check is interested in.
void	leaveToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)           Called after all the child nodes have been process.
void	visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)           Called to process a token.

 

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

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

 

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

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, 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

mClasses

private final java.util.Stack mClasses

keeps ClassDesc objects for stack of declared classes

Constructor Detail

FinalClassCheck

public FinalClassCheck()

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: com.puppycrawl.tools.checkstyle.api.Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

---

visitToken

public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)

Description copied from class: com.puppycrawl.tools.checkstyle.api.Check

Called to process a token.

---

leaveToken

public void leaveToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)

Description copied from class: com.puppycrawl.tools.checkstyle.api.Check

Called after all the child nodes have been process.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ design overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---