InterfaceIsTypeCheck

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ design overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck

SOURCE |

Download com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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.InterfaceIsTypeCheck

All Implemented Interfaces:: com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public final class InterfaceIsTypeCheck
extends com.puppycrawl.tools.checkstyle.api.Check

Implements Bloch, Effective Java, Item 17 - Use Interfaces only to define types.

An interface should describe a type, it is therefore inappropriate to define an interface that does not contain any methods but only constants.

The check can be configured to also disallow marker interfaces like java.io.Serializable, that do not contain methods or constants at all.

Version:: $Revision: 1.2 $

Field Summary

private boolean mAllowMarkerInterfaces
          flag to control whether marker interfaces are allowed.

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

InterfaceIsTypeCheck()


Method Summary

int[] getDefaultTokens()
          Returns the default token a check is interested in.

int[] getRequiredTokens()
          The tokens that this check must be registered for.

void setAllowMarkerInterfaces(boolean aFlag)
          Controls whether marker interfaces like Serializable are allowed.

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, getTabWidth, getTokenNames, init, leaveToken, 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

mAllowMarkerInterfaces

private boolean mAllowMarkerInterfaces

flag to control whether marker interfaces are allowed.

Constructor Detail