|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<LanguageVersion>
net.sourceforge.pmd.lang.LanguageVersion
public enum LanguageVersion
This is an enumeration of the Language versions of which PMD is aware. The primary use of a LanguageVersion is for Rules, but they are also used by utilities such as CPD.
The following are key components of a LanguageVersion in PMD:
LanguageVersion
,
LanguageVersionDiscoverer
Enum Constant Summary | |
---|---|
CPP
|
|
ECMASCRIPT
|
|
FORTRAN
|
|
JAVA_13
|
|
JAVA_14
|
|
JAVA_15
|
|
JAVA_16
|
|
JAVA_17
|
|
JSP
|
|
PHP
|
|
RUBY
|
|
XML
|
|
XSL
|
Method Summary | |
---|---|
static String |
commaSeparatedTerseNames(List<LanguageVersion> languageVersions)
Return a comma-separated list of LanguageVersion terse names. |
static LanguageVersion |
findByTerseName(String terseName)
A utility method to find the LanguageVersion associated with the given terse name. |
static List<LanguageVersion> |
findVersionsForLanguageTerseName(String languageTerseName)
A utility method to find the all version associated with the given terse name. |
static LanguageVersion |
getDefaultVersion()
Return the default version for PMD. |
Language |
getLanguage()
Get the Language for this LanguageVersion. |
LanguageVersionHandler |
getLanguageVersionHandler()
Get the LanguageVersionHandler for this LanguageVersion. |
String |
getName()
Get the name of this LanguageVersion. |
String |
getShortName()
Get the short name of this LanguageVersion. |
String |
getTerseName()
Get the terse name of this LanguageVersion. |
String |
getVersion()
Get the version String for this LanguageVersion. |
boolean |
isDefaultVersion()
Returns if this LanguageVersion is the default version for the Language. |
String |
toString()
A friendly String form of the LanguageVersion. |
static LanguageVersion |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
static LanguageVersion[] |
values()
Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final LanguageVersion CPP
public static final LanguageVersion FORTRAN
public static final LanguageVersion ECMASCRIPT
public static final LanguageVersion JAVA_13
public static final LanguageVersion JAVA_14
public static final LanguageVersion JAVA_15
public static final LanguageVersion JAVA_16
public static final LanguageVersion JAVA_17
public static final LanguageVersion JSP
public static final LanguageVersion PHP
public static final LanguageVersion RUBY
public static final LanguageVersion XSL
public static final LanguageVersion XML
Method Detail |
---|
public static LanguageVersion[] values()
for (LanguageVersion c : LanguageVersion.values()) System.out.println(c);
public static LanguageVersion valueOf(String name)
name
- the name of the enum constant to be returned.
IllegalArgumentException
- if this enum type has no constant
with the specified name
NullPointerException
- if the argument is nullpublic Language getLanguage()
public String getVersion()
public String getName()
public String getShortName()
public String getTerseName()
public LanguageVersionHandler getLanguageVersionHandler()
public boolean isDefaultVersion()
true
if this is the default version for the Language,
false
otherwise.public String toString()
toString
in class Enum<LanguageVersion>
public static LanguageVersion findByTerseName(String terseName)
terseName
- The LanguageVersion terse name.
null
if there is
no LanguageVersion with this terse name.public static List<LanguageVersion> findVersionsForLanguageTerseName(String languageTerseName)
languageTerseName
- The LanguageVersion terse name.
public static String commaSeparatedTerseNames(List<LanguageVersion> languageVersions)
languageVersions
- The language versions.
public static LanguageVersion getDefaultVersion()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |