Class InterfaceIsTypeCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public final class InterfaceIsTypeCheck
    extends AbstractCheck
    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.

    • 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
      • allowMarkerInterfaces

        private boolean allowMarkerInterfaces
        Flag to control whether marker interfaces are allowed.
    • Constructor Detail

      • InterfaceIsTypeCheck

        public InterfaceIsTypeCheck()
    • 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
      • 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
      • 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
      • setAllowMarkerInterfaces

        public void setAllowMarkerInterfaces​(boolean flag)
        Controls whether marker interfaces like Serializable are allowed.
        Parameters:
        flag - whether to allow marker interfaces or not