de.susebox.jtopas

Class TokenizerProperty

java.lang.Object

de.susebox.jtopas.TokenizerProperty

public class TokenizerProperty
extends java.lang.Object

This class is mainly used by TokenizerProperties implementations to return Iterator objects of their various properties (keywords, special sequences etc.). Moreover, it can be used whereever information about a lexical element description is needed, for instance when firing a TokenizerPropertyEvent.

This class replaces the older de.susebox.java.util.TokenizerProperty class which is deprecated.

Author:

Heiko Blau

See Also:

TokenizerProperties

Field Summary

Fields

Modifier and Type	Field and Description
static byte	PARSE_FLAG_MASK The property describes a parse flag mask.

Constructor Summary

Constructors

Constructor and Description
TokenizerProperty() Default constructor.
TokenizerProperty(int type) Constructs a TokenizerProperty where only the type is known so far.
TokenizerProperty(int type, java.lang.String[] images) Constructs a TokenizerProperty with type and image(s).
TokenizerProperty(int type, java.lang.String[] images, java.lang.Object companion) Constructs a TokenProperty object with a set of type, image(s) and companion.
TokenizerProperty(int type, java.lang.String[] images, java.lang.Object companion, int flags) Constructs a TokenProperty object with a set of type, image(s), companion object and flags.
TokenizerProperty(int type, java.lang.String[] images, java.lang.Object companion, int flags, int flagMask) Constructs a TokenProperty object with a set of type, image(s), companion object and flags with an associated flag mask (setFlags(int, int) for details).

Method Summary

Modifier and Type	Method and Description
boolean	containsFlag(int flag) Checks wether a given flag is in the current flag mask.
boolean	equals(java.lang.Object that) Redefinition of the well-known Object.equals(java.lang.Object) method.
java.lang.Object	getCompanion() Obtaining the associated information of the token.
int	getFlagMask() Retrieving the current flag mask containing the bits that are valid in the return value of getFlags().
int	getFlags() Retrieving the flags of this property.
java.lang.String[]	getImages() Retrieving the one or more images a lexical element description has.
int	getType() Retrieving the type of this property.
boolean	isFlagSet(int flag, boolean defVal) Checks wether a given flag is set or cleared for this property.
void	setCompanion(java.lang.Object companion) Some token may have associated informations for the user of the Token.
void	setFlags(int flags) Setting flags.
void	setFlags(int flags, int flagMask) Setting the values for the flags contained in the flag mask.
void	setImages(java.lang.String[] images) Images of lexical elements are quite different.
void	setType(int type) Setting the type of the TokenizerProperty.
java.lang.String	toString() Redefinition of the well-known Object.toString() method.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PARSE_FLAG_MASK

public static final byte PARSE_FLAG_MASK

The property describes a parse flag mask. This type is nessecary for the "parse flag changed" event fired by TokenizerProperties implementations.

See Also:

Constant Field Values

Constructor Detail

TokenizerProperty

public TokenizerProperty()

Default constructor. Initializes a property with type Token.UNKNOWN and no images or flags.

TokenizerProperty

public TokenizerProperty(int type)

Constructs a TokenizerProperty where only the type is known so far. For the type, one of the constants defined in Token must be used.

Parameters:

type - the property type

TokenizerProperty

public TokenizerProperty(int type,
                         java.lang.String[] images)

Constructs a TokenizerProperty with type and image(s). For the type, one of the constants defined in Token must be used.

Parameters:

type - the property type

images - the characterising images of a lexical element

TokenizerProperty

public TokenizerProperty(int type,
                         java.lang.String[] images,
                         java.lang.Object companion)

Constructs a TokenProperty object with a set of type, image(s) and companion.

Parameters:

type - the property type

images - the characterising images of a lexical element

companion - the associated information for the lexical element

TokenizerProperty

public TokenizerProperty(int type,
                         java.lang.String[] images,
                         java.lang.Object companion,
                         int flags)

Constructs a TokenProperty object with a set of type, image(s), companion object and flags.

Parameters:

type - the property type

images - the characterising images of a lexical element

companion - the associated information for the lexical element

flags - the specific parse flags for this lexical element

TokenizerProperty

public TokenizerProperty(int type,
                         java.lang.String[] images,
                         java.lang.Object companion,
                         int flags,
                         int flagMask)

Constructs a TokenProperty object with a set of type, image(s), companion object and flags with an associated flag mask (setFlags(int, int) for details).

Parameters:

type - the property type

images - the characterising images of a lexical element

companion - the associated information for the lexical element

flags - the specific parse flags for this lexical element

flagMask - which bits of the parse flags are actually valid

Method Detail

setType

public void setType(int type)

Setting the type of the TokenizerProperty. Usually, one of the constants defined in Token is passed to this method, for instance Token.NORMAL, Token.KEYWORD or Token.WHITESPACE.
However, implementations and subclasses of the interfaces and classes in the package de.susebox.jtopas may define, set and return their own type constants.

Parameters:

type - type of the tokenizer property (one of the Token constants)

See Also:

Token, getType()

getType

public int getType()

Retrieving the type of this property. Usually, one of the constants defined in Token is returned, for instance Token.NORMAL, Token.KEYWORD or Token.WHITESPACE. However, implementations and subclasses of the interfaces and classes in the package de.susebox.jtopas may define, set and return their own type constants.

Returns:

type of the property

See Also:

setType(int)

setFlags

public void setFlags(int flags)

Setting flags. These flags are not specified here. Usually, a combination of TokenizerProperties F_... constants is used here.
The method is equivalent to setFlags(int, int)(flags, flags).

Parameters:

flags - a bitmask

See Also:

getFlags()

setFlags

public void setFlags(int flags,
                     int flagMask)

Setting the values for the flags contained in the flag mask. The flags are not specified here. Usually, a combination of TokenizerProperties F_... constants is used here.
The flag mask contains the set flags that are valid for this TokenizerProperty. Flags that are not contained in the flag mask, have an "unknown" value in this instance.
A flag mask value of -1 means that all flags should are valid. flag = 0 and flagMask = TokenizerProperties.F_CASE means that the property is case-insensitive, but there are no other characteristics explicitely set for this property.

Parameters:

flags - a bitmask of flags to be set or clear

flagMask - a bitmask containing the flags that are valid in flags

See Also:

getFlags()

getFlags

public int getFlags()

Retrieving the flags of this property.

Returns:

flags of the property

See Also:

setFlags(int), #getFlags(int)

getFlagMask

public int getFlagMask()

Retrieving the current flag mask containing the bits that are valid in the return value of getFlags(). The return value -1 means that all bits in getFlags are explicitely set for this property.

Returns:

a bitmask containing the flags that are explicitely set for this property

See Also:

getFlags(), setFlags(int, int)

isFlagSet

public boolean isFlagSet(int flag,
                         boolean defVal)

Checks wether a given flag is set or cleared for this property. The default value is returned if the current flag mask (see getFlagMask()) does not contain the given flag. This is the case if containsFlag(int) would return false for the given flag.
If containsFlag returns true for the given flag, isFlagSet returns true only if the all bits in the given flag are in the current flags.

Parameters:

flag - the flag to check

defVal - the default value if the flag is not contained in the current flag mask

Returns:

true if the given flag is explicitely set or the default value is true, false if the given flag is explicitely cleared or the default value is false.

containsFlag

public boolean containsFlag(int flag)

Checks wether a given flag is in the current flag mask. That means that the property contains its own explicit value for the flag.
The method can be used in combination with isFlagSet(int, boolean) to determine wether the return value of isFlagSet is actually the default value given to that method, or the flag value of the property itself.
The method returns true only if the all bits in the given flag are in the current flag mask.

Parameters:

flag - the flag to check

defVal - the default value if the flag is not contained in the current flag mask

Returns:

true if the given flag is explicitely set or the default value is true, false if the given flag is explicitely cleared or the default value is false.

setImages

public void setImages(java.lang.String[] images)
               throws java.lang.IllegalArgumentException

Images of lexical elements are quite different. Starting sequences of line comments, keywords and special sequences are strings representing only themselfes. Whitespaces and separators are represented as string consisting of the single whitespace and separator characters and / or character ranges.
A block comment is represented an array of two strings. The first is the starting sequence, the second the finishing sequence. The same is true for string elements. However, string elements usually have an escape sequence.

Parameters:

images - the characterising images of a lexical element

Throws:

java.lang.IllegalArgumentException

getImages

public java.lang.String[] getImages()

Retrieving the one or more images a lexical element description has.

Returns:

the array with images like string start and end sequences etc.

See Also:

setImages(java.lang.String[])

setCompanion

public void setCompanion(java.lang.Object companion)

Some token may have associated informations for the user of the Token. A popular thing would be the association of an integer constant to a special sequence or keyword to be used in fast switch statetents.

Parameters:

companion - the associated information for the lexical element

getCompanion

public java.lang.Object getCompanion()

Obtaining the associated information of the token. Can be null. See setCompanion(java.lang.Object) for details.

Returns:

the associated information of this token

equals

public boolean equals(java.lang.Object that)

Redefinition of the well-known Object.equals(java.lang.Object) method.

Overrides:

equals in class java.lang.Object

Parameters:

that - compare this instance with that object

Returns:

true if the two object describe the same property, false otherwise

toString

public java.lang.String toString()

Redefinition of the well-known Object.toString() method.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this TokenizerProperty