eu.cqse.check.framework.scanner

Enum ELanguage

java.lang.Object

java.lang.Enum<ELanguage>

eu.cqse.check.framework.scanner.ELanguage

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ELanguage>

public enum ELanguage
extends java.lang.Enum<ELanguage>

Enumeration class for the languages support by the scanner framework. This class is used for communication with IDE clients (via the org.conqat.engine.service.shared.client.IdeServiceClient), so special care has to be taken when changing its signature!

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABAP ABAP
ABAP_DDIC ABAP Dictionary.
ADA Ada
COBOL COBOL
CPP C/C++
CS C#
DELPHI Delphi
FORTRAN Fortran
GO Go
GOSU Gosu (https://gosu-lang.github.io/).
GROOVY Groovy
HANA_VIEW HANA Views XML.
IEC61131 IEC 61131-3 Structured Text.
JAVA Java
JAVADOC JavaDoc
JAVASCRIPT JavaScript including EcmaScript and TypeScript.
JPL The "Just Your Average Computer Company Procedural Language".
KOTLIN Kotlin.
LINE Use this for languages for which no dedicated scanner is available.
MATLAB Matlab
MTEXT The language used within the M/Text printing system.
NL_REQUIREMENTS Requirement documents.
NL_TESTS Requirement documents.
OBJECTIVE_C Objective C.
OCAML OCaml
OPEN_CL OpenCL C/C++
OSCRIPT Opentext Oscript
PHP PHP
PL1 PL/I
PLSQL PL/SQL
PYTHON Python
RUBY Ruby
RUST Rust
SIMULINK Simulink and Stateflow.
SQLSCRIPT HANA SQLScript
SWIFT Swift
TEXT Natural language text
TSQL T-SQL aka Transact SQL.
VB Visual Basic
XML XML
XTEND Xtend

Method Summary

Modifier and Type	Method and Description
static ELanguage	fromFile(java.io.File file) Gets the ELanguage value corresponding to the file extension of the file.
static ELanguage	fromFileExtension(java.lang.String extension) Gets the ELanguage value corresponding to the given file extension (without a dot).
static ELanguage	fromPath(java.lang.String path) Gets the ELanguage value corresponding to the file extension of the path.
static ELanguage	fromResource(Resource resource) Gets the ELanguage value corresponding to the extension of the resource.
static java.util.Set<ELanguage>	getAllLanguagesForExtension(java.lang.String extension) Returns all languages for the given file extension
static java.util.Set<ELanguage>	getAllLanguagesForPath(java.lang.String path) Returns all ELanguages matching the file extension of the given file path.
java.lang.String[]	getFileExtensions() Get the file extensions commonly used for this language.
java.lang.String	getReadableName() Returns readableName.
boolean	isCaseSensitive() Return whether the language is case sensitive.
static boolean	languageHasMethods(ELanguage language)
static ELanguage	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ELanguage[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JAVA

public static final ELanguage JAVA

Java

CPP

public static final ELanguage CPP

C/C++

OPEN_CL

public static final ELanguage OPEN_CL

OpenCL C/C++

RUST

public static final ELanguage RUST

Rust

VB

public static final ELanguage VB

Visual Basic

PL1

public static final ELanguage PL1

PL/I

COBOL

public static final ELanguage COBOL

COBOL

CS

public static final ELanguage CS

C#

ABAP

public static final ELanguage ABAP

ABAP

ABAP_DDIC

public static final ELanguage ABAP_DDIC

ABAP Dictionary. This is a textual representation of objects in the ABAP Dictionary (aka DDIC). The format is based on the textual format for structure and database table definition which is available starting with SAP ABP Platform v7.51 or v7.52 respectively. See https://help.sap.com/doc/abapdocu_752_index_htm/7.52/de-DE/abenddic_tools.htm. This format is again based on the SAP CDS DDL https://help.sap.com/doc/abapdocu_752_index_htm/7.52/de-DE/abencds_f1_ddl_syntax.htm. If available, we export ABAP DDIC objects in the textual representation as provided by the SAP system, otherwise our Teamscale Connector for the SAP ABAP Platform serializes the text in a similar format.

ADA

public static final ELanguage ADA

Ada

TEXT

public static final ELanguage TEXT

Natural language text

XML

public static final ELanguage XML

XML

SQLSCRIPT

public static final ELanguage SQLSCRIPT

HANA SQLScript

HANA_VIEW

public static final ELanguage HANA_VIEW

HANA Views XML. This includes view specifications which of SAP HANA database which are stored in XML. Does NOT include HANA code which is not XML (e.g. *.hdbview)

PLSQL

public static final ELanguage PLSQL

PL/SQL

PYTHON

public static final ELanguage PYTHON

Python

TSQL

public static final ELanguage TSQL

T-SQL aka Transact SQL.

MATLAB

public static final ELanguage MATLAB

Matlab

PHP

public static final ELanguage PHP

PHP

RUBY

public static final ELanguage RUBY

Ruby

JAVASCRIPT

public static final ELanguage JAVASCRIPT

JavaScript including EcmaScript and TypeScript.

Note that the statement oracle only works if semicolons are used consistently. However, semicolons are optional in JavaScript (rules described here: http://bclary.com/2004/11/07/#a-7.9), but to determine end of statement in this case requires a full blown parser (hard to decide locally in some cases). As most coding guidelines recommend using semicolons anyway, we stick with this solution.

MTEXT

public static final ELanguage MTEXT

The language used within the M/Text printing system.

JPL

public static final ELanguage JPL

The "Just Your Average Computer Company Procedural Language". A C-like language being part of the Panther framework developed by the company Prolifics. The language is used in the archive system d.3 developed by the company "d.velop".

LINE

public static final ELanguage LINE

Use this for languages for which no dedicated scanner is available. Creates a token per line (and creates EOL tokens).

DELPHI

public static final ELanguage DELPHI

Delphi

IEC61131

public static final ELanguage IEC61131

IEC 61131-3 Structured Text. We understand both the code (PU) and variable structure (SV).

• .pou files contain program code (written in ST language)
• .dt files contain type declarations (written in ST language)

Sadly, the file endings and format are not standardized in IEC-61131-3.

FORTRAN

public static final ELanguage FORTRAN

Fortran

XTEND

public static final ELanguage XTEND

Xtend

SWIFT

public static final ELanguage SWIFT

Swift

OCAML

public static final ELanguage OCAML

OCaml

OSCRIPT

public static final ELanguage OSCRIPT

Opentext Oscript

GROOVY

public static final ELanguage GROOVY

Groovy

NL_REQUIREMENTS

public static final ELanguage NL_REQUIREMENTS

Requirement documents.

NL_TESTS

public static final ELanguage NL_TESTS

Requirement documents.

SIMULINK

public static final ELanguage SIMULINK

Simulink and Stateflow.

GOSU

public static final ELanguage GOSU

Gosu (https://gosu-lang.github.io/).

KOTLIN

public static final ELanguage KOTLIN

Kotlin.

OBJECTIVE_C

public static final ELanguage OBJECTIVE_C

Objective C.

JAVADOC

public static final ELanguage JAVADOC

JavaDoc

GO

public static final ELanguage GO

Go

Method Detail

values

public static ELanguage[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ELanguage c : ELanguage.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ELanguage valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getReadableName

public java.lang.String getReadableName()

Returns readableName.

isCaseSensitive

public boolean isCaseSensitive()

Return whether the language is case sensitive.

getFileExtensions

public java.lang.String[] getFileExtensions()

Get the file extensions commonly used for this language.

fromResource

public static ELanguage fromResource(Resource resource)

Gets the ELanguage value corresponding to the extension of the resource. Returns null if no extension was found. If there are multiple possible languages, the first one is returned.

fromPath

public static ELanguage fromPath(java.lang.String path)

Gets the ELanguage value corresponding to the file extension of the path. Returns null if no extension was found. If there are multiple possible languages, the first one is returned. This method should only be used for test code or as a fallback since file extensions may match multiple ELanguages.

fromFile

public static ELanguage fromFile(java.io.File file)

Gets the ELanguage value corresponding to the file extension of the file. Returns null if no extension was found. If there are multiple possible languages, the first one is returned. This method should only be used for test code or as a fallback since file extensions may match multiple ELanguages.

fromFileExtension

public static ELanguage fromFileExtension(java.lang.String extension)

Gets the ELanguage value corresponding to the given file extension (without a dot). Returns LINE as a fallback if no language was registered for the extension. If there are multiple possible languages registered for the extension, however, the first one is returned.

getAllLanguagesForExtension

public static java.util.Set<ELanguage> getAllLanguagesForExtension(java.lang.String extension)

Returns all languages for the given file extension

getAllLanguagesForPath

public static java.util.Set<ELanguage> getAllLanguagesForPath(java.lang.String path)

Returns all ELanguages matching the file extension of the given file path.

languageHasMethods

public static boolean languageHasMethods(ELanguage language)

Returns:

Whether the given language has the concept of methods.