Package net.sourceforge.pmd.lang

Class BaseLanguageModule

  • All Implemented Interfaces:
    java.lang.Comparable<Language>, Language
    public abstract class BaseLanguageModule
extends java.lang.Object
implements Language
    Created by christoferdutz on 21.09.14.

    • Field Detail

      • name

        protected java.lang.String name

      • shortName

        protected java.lang.String shortName

      • terseName

        protected java.lang.String terseName

      • ruleChainVisitorClass

        protected java.lang.Class<?> ruleChainVisitorClass

      • extensions

        protected java.util.List<java.lang.String> extensions

      • versions

        protected java.util.Map<java.lang.String,​LanguageVersion> versions

    • Constructor Detail

      • BaseLanguageModule

        public BaseLanguageModule​(java.lang.String name,
                          java.lang.String shortName,
                          java.lang.String terseName,
                          java.lang.Class<?> ruleChainVisitorClass,
                          java.lang.String... extensions)

    • Method Detail

      • addVersion

        protected void addVersion​(java.lang.String version,
                          LanguageVersionHandler languageVersionHandler,
                          boolean isDefault)

      • getName

        public java.lang.String getName()
        Description copied from interface: Language
        Get the full name of this Language. This is generally the name of this Language without the use of acronyms.
        Specified by:
        getName in interface Language
        Returns:
        The full name of this Language.

      • getShortName

        public java.lang.String getShortName()
        Description copied from interface: Language
        Get the short name of this Language. This is the commonly used short form of this Language's name, perhaps an acronym.
        Specified by:
        getShortName in interface Language
        Returns:
        The short name of this Language.

      • getTerseName

        public java.lang.String getTerseName()
        Description copied from interface: Language
        Get the terse name of this Language. This is used for Rule configuration.
        Specified by:
        getTerseName in interface Language
        Returns:
        The terse name of this Language.

      • getRuleChainVisitorClass

        public java.lang.Class<?> getRuleChainVisitorClass()
        Description copied from interface: Language
        Get the RuleChainVisitor implementation class used when visiting the AST structure for this Rules for this Language.
        Specified by:
        getRuleChainVisitorClass in interface Language
        Returns:
        The RuleChainVisitor class.
        See Also:
        RuleChainVisitor

      • getExtensions

        public java.util.List<java.lang.String> getExtensions()
        Description copied from interface: Language
        Get the list of file extensions associated with this Language.
        Specified by:
        getExtensions in interface Language
        Returns:
        List of file extensions.

      • hasExtension

        public boolean hasExtension​(java.lang.String extension)
        Description copied from interface: Language
        Returns whether the given Language handles the given file extension. The comparison is done ignoring case.
        Specified by:
        hasExtension in interface Language
        Parameters:
        extension - A file extension.
        Returns:
        true if this Language handles this extension, false otherwise.

      • getVersions

        public java.util.List<LanguageVersion> getVersions()
        Description copied from interface: Language
        Gets the list of supported LanguageVersion for this Language.
        Specified by:
        getVersions in interface Language
        Returns:
        The LanguageVersion for this Language.

      • hasVersion

        public boolean hasVersion​(java.lang.String version)
        Specified by:
        hasVersion in interface Language

      • getVersion

        public LanguageVersion getVersion​(java.lang.String versionName)
        Description copied from interface: Language
        Get the LanguageVersion for the version string from this Language.
        Specified by:
        getVersion in interface Language
        Parameters:
        versionName - The language version string.
        Returns:
        The corresponding LanguageVersion, null if the version string is not recognized.

      • getDefaultVersion

        public LanguageVersion getDefaultVersion()
        Description copied from interface: Language
        Get the current PMD defined default LanguageVersion for this Language. This is an arbitrary choice made by the PMD product, and can change between PMD releases. Every Language has a default version.
        Specified by:
        getDefaultVersion in interface Language
        Returns:
        The current default LanguageVersion for this Language.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • compareTo

        public int compareTo​(Language o)
        Specified by:
        compareTo in interface java.lang.Comparable<Language>