Package net.sourceforge.pmd.util.fxdesigner.util.codearea

Enum AvailableSyntaxHighlighters

java.lang.Object

java.lang.Enum<AvailableSyntaxHighlighters>

net.sourceforge.pmd.util.fxdesigner.util.codearea.AvailableSyntaxHighlighters

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AvailableSyntaxHighlighters>, SyntaxHighlighter

public enum AvailableSyntaxHighlighters
extends java.lang.Enum<AvailableSyntaxHighlighters>
implements SyntaxHighlighter

Lists the available syntax highlighter engines by language.

Since:

6.0.0

Author:

Clément Fournier

Enum Constant Summary

Enum Constants

Enum Constant	Description
APEX
JAVA
KOTLIN
POM
SCALA
WSDL
XML
XPATH
XSL

Method Summary

Modifier and Type	Method	Description
org.fxmisc.richtext.model.StyleSpans<java.util.Collection<java.lang.String>>	computeHighlighting(java.lang.String text)	Computes the syntax highlighting on the given text.
static java.util.Optional<SyntaxHighlighter>	getHighlighterForLanguage(net.sourceforge.pmd.lang.Language language)	Gets the highlighter for a language if available.
java.lang.String	getLanguageTerseName()	Gets the terse name of the language this highlighter cares for.
static AvailableSyntaxHighlighters	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static AvailableSyntaxHighlighters[]	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 AvailableSyntaxHighlighters JAVA

SCALA

public static final AvailableSyntaxHighlighters SCALA

KOTLIN

public static final AvailableSyntaxHighlighters KOTLIN

APEX

public static final AvailableSyntaxHighlighters APEX

XML

public static final AvailableSyntaxHighlighters XML

XSL

public static final AvailableSyntaxHighlighters XSL

WSDL

public static final AvailableSyntaxHighlighters WSDL

POM

public static final AvailableSyntaxHighlighters POM

XPATH

public static final AvailableSyntaxHighlighters XPATH

Method Detail

values

public static AvailableSyntaxHighlighters[] 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 (AvailableSyntaxHighlighters c : AvailableSyntaxHighlighters.values())
    System.out.println(c);

Returns:

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

valueOf

public static AvailableSyntaxHighlighters 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

getLanguageTerseName

public java.lang.String getLanguageTerseName()

Description copied from interface: SyntaxHighlighter

Gets the terse name of the language this highlighter cares for. That's used as a css class for text regions.

Specified by:

getLanguageTerseName in interface SyntaxHighlighter

Returns:

The terse name of the language

computeHighlighting

public org.fxmisc.richtext.model.StyleSpans<java.util.Collection<java.lang.String>> computeHighlighting(java.lang.String text)

Description copied from interface: SyntaxHighlighter

Computes the syntax highlighting on the given text. The returned spans are exactly the length of the given text.

Specified by:

computeHighlighting in interface SyntaxHighlighter

Parameters:

text - The text

Returns:

The computed style spans

getHighlighterForLanguage

public static java.util.Optional<SyntaxHighlighter> getHighlighterForLanguage(net.sourceforge.pmd.lang.Language language)

Gets the highlighter for a language if available.

Parameters:

language - Language to look for

Returns:

A highlighter, if available