org.youscope.common.scripting

Class JavaScriptStyle

java.lang.Object

org.youscope.common.scripting.JavaScriptStyle

All Implemented Interfaces:

ScriptStyle

public class JavaScriptStyle
extends java.lang.Object
implements ScriptStyle

Script style for JavaScript scripts.

Author:

langmo

Constructor Summary

Constructors

Constructor and Description
JavaScriptStyle() Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBlockCommentEndDelimiter() Returns the character sequence used in the language to end a block comment.
java.lang.String	getBlockCommentStartDelimiter() Returns the character sequence used in the language to start a block comment.
java.lang.String	getEscapeQuoteDelimiter(java.lang.String quoteDelimiter) Returns the string used to print the given quote delimiter inside a quote without stopping the quote (if quote delimiter is e.g.
java.lang.String[]	getFileNameExtensions() Returns an array of all file name extensions typically associated with scripts for which this style is made.
java.lang.String[]	getScriptLanguageNames() Should return a list of the names of all scripting language implemented by the respective implementation (e.g.
java.lang.String	getScriptStyleID() Should return a unique ID with which the script style implementation can be identified.
java.lang.String	getSingleLineDelimiter() Returns the character sequence used in the language to start a single line comment.
boolean	isDelimiter(java.lang.String character) Returns true if the given character delimits two words/commands (e.g.
boolean	isKeyword(java.lang.String token) Returns true if the given token is a language specific keyword (e.g.
boolean	isQuoteDelimiter(java.lang.String character) Returns true if the given character can be used to delimit a quote (e.g.
boolean	supportsFileNameExtension(java.lang.String extension) Returns true if the given file name extension is typically associated with scripts for which this style is made.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaScriptStyle

public JavaScriptStyle()

Constructor.

Method Detail

isDelimiter

public boolean isDelimiter(java.lang.String character)

Description copied from interface: ScriptStyle

Returns true if the given character delimits two words/commands (e.g. ".", ",", ";", ...)

Specified by:

isDelimiter in interface ScriptStyle

Parameters:

character - The character for which it should be queried if it is a delimiter.

Returns:

True if character is a delimiter.

isQuoteDelimiter

public boolean isQuoteDelimiter(java.lang.String character)

Description copied from interface: ScriptStyle

Returns true if the given character can be used to delimit a quote (e.g. " or ').

Specified by:

isQuoteDelimiter in interface ScriptStyle

Parameters:

character - The character for which it should be queried if it is a quote delimiter.

Returns:

True if character is a quote delimiter.

isKeyword

public boolean isKeyword(java.lang.String token)

Description copied from interface: ScriptStyle

Returns true if the given token is a language specific keyword (e.g. "global", "function", ...).

Specified by:

isKeyword in interface ScriptStyle

Returns:

true if the token is a keyword.

getBlockCommentStartDelimiter

public java.lang.String getBlockCommentStartDelimiter()

Description copied from interface: ScriptStyle

Returns the character sequence used in the language to start a block comment.

Specified by:

getBlockCommentStartDelimiter in interface ScriptStyle

Returns:

Character sequence to start a block comment, or null if block comments do not exist in the language.

getBlockCommentEndDelimiter

public java.lang.String getBlockCommentEndDelimiter()

Description copied from interface: ScriptStyle

Returns the character sequence used in the language to end a block comment.

Specified by:

getBlockCommentEndDelimiter in interface ScriptStyle

Returns:

Character sequence to end a block comment, or null if block comments do not exist in the language.

getSingleLineDelimiter

public java.lang.String getSingleLineDelimiter()

Description copied from interface: ScriptStyle

Returns the character sequence used in the language to start a single line comment.

Specified by:

getSingleLineDelimiter in interface ScriptStyle

Returns:

Character sequence to start a single line comment, or null if single line comments do not exist in the language.

getEscapeQuoteDelimiter

public java.lang.String getEscapeQuoteDelimiter(java.lang.String quoteDelimiter)

Description copied from interface: ScriptStyle

Returns the string used to print the given quote delimiter inside a quote without stopping the quote (if quote delimiter is e.g. ", the escaped one might be \").

Specified by:

getEscapeQuoteDelimiter in interface ScriptStyle

Parameters:

quoteDelimiter - The escaped version of the quote delimiter.

Returns:

the escaped quote delimiter, or null if not existing.

getFileNameExtensions

public java.lang.String[] getFileNameExtensions()

Description copied from interface: ScriptStyle

Returns an array of all file name extensions typically associated with scripts for which this style is made.

Specified by:

getFileNameExtensions in interface ScriptStyle

Returns:

List of typical file extensions.

supportsFileNameExtension

public boolean supportsFileNameExtension(java.lang.String extension)

Description copied from interface: ScriptStyle

Returns true if the given file name extension is typically associated with scripts for which this style is made.

Specified by:

supportsFileNameExtension in interface ScriptStyle

Returns:

true if this extension is typically for script files of this type.

getScriptStyleID

public java.lang.String getScriptStyleID()

Description copied from interface: ScriptStyle

Should return a unique ID with which the script style implementation can be identified. Different to the name of the script language, the ID should be different for every implementation.

Specified by:

getScriptStyleID in interface ScriptStyle

Returns:

Unique ID for the script style implementation.

getScriptLanguageNames

public java.lang.String[] getScriptLanguageNames()

Description copied from interface: ScriptStyle

Should return a list of the names of all scripting language implemented by the respective implementation (e.g. JavaScript). If two scripting style implementations are styles for the same language, they should return the same name.

Specified by:

getScriptLanguageNames in interface ScriptStyle

Returns:

Names of scripting languages supported by this style.