Package org.mariuszgromada.math.mxparser.parsertokens

Class KeyWord

java.lang.Object

org.mariuszgromada.math.mxparser.parsertokens.KeyWord

All Implemented Interfaces:

java.io.Serializable

public class KeyWord
extends java.lang.Object
implements java.io.Serializable

Class representing key words knowon to the parser

Version:

5.2.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	description
static int	NO_DEFINITION
private static int	serialClassID
private static long	serialVersionUID
java.lang.String	since
java.lang.String	syntax
int	wordId
java.lang.String	wordString
int	wordTypeId

Constructor Summary

Constructors

Constructor	Description
KeyWord()
KeyWord(java.lang.String wordString, java.lang.String description, int wordId, java.lang.String syntax, java.lang.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

serialClassID

private static final int serialClassID

See Also:

Constant Field Values

serialVersionUID

private static final long serialVersionUID

NO_DEFINITION

public static final int NO_DEFINITION

See Also:

Constant Field Values

wordString

public java.lang.String wordString

wordId

public int wordId

wordTypeId

public int wordTypeId

description

public java.lang.String description

syntax

public java.lang.String syntax

since

public java.lang.String since

Constructor Detail

KeyWord

public KeyWord()

KeyWord

public KeyWord(java.lang.String wordString,
               java.lang.String description,
               int wordId,
               java.lang.String syntax,
               java.lang.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