Class InnerTypeLastCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck
All Implemented Interfaces:
Configurable, Contextualizable
public class InnerTypeLastCheck extends AbstractCheck

Checks nested (internal) classes/interfaces are declared at the bottom of the primary (top-level) class after all init and static init blocks, method, constructor and field declarations.

To configure the check: 

<module name="InnerTypeLast"/>

Example:

class Test {
    private String s; // OK
    class InnerTest1 {}
    public void test() {} // violation, method should be declared before inner types.
}

class Test2 {
    static {}; // OK
    class InnerTest1 {}
    public Test2() {} // violation, constructor should be declared before inner types.
}

class Test3 {
    private String s; // OK
    public void test() {} // OK
    class InnerTest1 {}
}

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • arrangement.members.before.inner
Since:
5.2

  • Field Details

    • MSG_KEY

      public static final String MSG_KEY
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:

    • CLASS_MEMBER_TOKENS

      private static final List<Integer> CLASS_MEMBER_TOKENS
      List of class member tokens.

    • rootClass

      private boolean rootClass
      Meet a root class.

  • Constructor Details

    • InnerTypeLastCheck

      public InnerTypeLastCheck()

  • Method Details

    • getDefaultTokens

      public int[] getDefaultTokens()
      Description copied from class: AbstractCheck
      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 AbstractCheck
      Returns:
      the default tokens
      See Also:

    • getAcceptableTokens

      public int[] getAcceptableTokens()
      Description copied from class: AbstractCheck
      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.
      Specified by:
      getAcceptableTokens in class AbstractCheck
      Returns:
      the token set this check is designed for.
      See Also:

    • getRequiredTokens

      public int[] getRequiredTokens()
      Description copied from class: AbstractCheck
      The tokens that this check must be registered for.
      Specified by:
      getRequiredTokens in class AbstractCheck
      Returns:
      the token set this must be registered for.
      See Also:

    • beginTree

      public void beginTree(DetailAST rootAST)
      Description copied from class: AbstractCheck
      Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.
      Overrides:
      beginTree in class AbstractCheck
      Parameters:
      rootAST - the root of the tree

    • visitToken

      public void visitToken(DetailAST ast)
      Description copied from class: AbstractCheck
      Called to process a token.
      Overrides:
      visitToken in class AbstractCheck
      Parameters:
      ast - the token to process

    • leaveToken

      public void leaveToken(DetailAST ast)
      Description copied from class: AbstractCheck
      Called after all the child nodes have been process.
      Overrides:
      leaveToken in class AbstractCheck
      Parameters:
      ast - the token leaving