Package org.mariuszgromada.math.mxparser.parsertokens

Class KeyWord

java.lang.Object

org.mariuszgromada.math.mxparser.parsertokens.KeyWord

public class KeyWord
extends Object

Class representing key words knowon to the parser

Version:

5.0.7

Author:

Mariusz Gromada
MathParser.org - mXparser project page
mXparser on GitHub
INFIMA place to purchase a commercial MathParser.org-mXparser software license
info@mathparser.org
ScalarMath.org - a powerful math engine and math scripting language
Scalar Lite
Scalar Pro
MathSpace.pl

Field Summary

Fields

Modifier and Type	Field	Description
String	description
static int	NO_DEFINITION
String	since
String	syntax
int	wordId
String	wordString
int	wordTypeId

Constructor Summary

Constructors

Constructor	Description
KeyWord()
KeyWord(String wordString, String description, int wordId, String syntax, String since, int wordTypeId)	Constructor - creates key words form wordString wordId wordTypId syntax since

Method Summary

Modifier and Type	Method	Description
static boolean	isFunctionForm(KeyWord kw)	Checks whether the specified keyword is in the form of a function.

Methods inherited from class java.lang.Object

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

Field Detail

NO_DEFINITION

public static final int NO_DEFINITION

See Also:

Constant Field Values

wordString

public String wordString

wordId

public int wordId

wordTypeId

public int wordTypeId

description

public String description

syntax

public String syntax

since

public String since

Constructor Detail

KeyWord

public KeyWord()

KeyWord

public KeyWord(String wordString,
               String description,
               int wordId,
               String syntax,
               String since,
               int wordTypeId)

Constructor - creates key words form wordString wordId wordTypId syntax since

Parameters:

wordString - the word string (refers to below interfaces)

wordId - the word identifier (refers to below interfaces)

wordTypeId - the word type (refers to below interfaces)

description - the word description

syntax - the word syntax

since - the word version since

Method Detail

isFunctionForm

public static boolean isFunctionForm(KeyWord kw)

Checks whether the specified keyword is in the form of a function.

Parameters:

kw - Provided key word.

Returns:

True in case kw is Function1Arg, Function2Arg, Function3Arg, FunctionVariadic, Function, RecursiveArgument otherwise returns false.

See Also:

Function1Arg, Function2Arg, Function3Arg, FunctionVariadic, Function, RecursiveArgument