Package com.puppycrawl.tools.checkstyle.checks

Class ArrayTypeStyleCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class ArrayTypeStyleCheck
extends AbstractCheck

    Checks the style of array type definitions. Some like Java style: public static void main(String[] args) and some like C style: public static void main(String args[]).

    By default the Check enforces Java style.

    This check strictly enforces only Java style for method return types regardless of the value for 'javaStyle'. For example, byte[] getData(). This is because C doesn't compile methods with array declarations on the name.

    • Property javaStyle - Control whether to enforce Java style (true) or C style (false). Type is boolean. Default value is true.

    To configure the check to enforce Java style: 

     <module name="ArrayTypeStyle"/>

    Example: 

     public class MyClass {
   int[] nums; // OK
   String strings[]; // violation

   char[] toCharArray() { // OK
     return null;
   }

   byte getData()[] { // violation
     return null;
   }
 }

    To configure the check to enforce C style: 

     <module name="ArrayTypeStyle">
   <property name="javaStyle" value="false"/>
 </module>

    Example: 

     public class MyClass {
   int[] nums; // violation
   String strings[]; // OK

   char[] toCharArray() { // OK
     return null;
   }

   byte getData()[] { // violation
     return null;
   }
 }

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • array.type.style
    Since:
    3.1

    • Field Detail

      • MSG_KEY

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

    • Constructor Detail

      • ArrayTypeStyleCheck

        public ArrayTypeStyleCheck()

    • Method Detail

      • 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:
        TokenTypes

      • 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:
        TokenTypes

      • 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:
        TokenTypes

      • setJavaStyle

        public void setJavaStyle​(boolean javaStyle)
        Setter to control whether to enforce Java style (true) or C style (false).
        Parameters:
        javaStyle - true if Java style should be used.