org.knime.core.util.tokenizer
Class Comment

java.lang.Object
  org.knime.core.util.tokenizer.Comment

public class Comment
extends Object

Created for each comment pattern of the FileTokenizer keeping its specifics.

Author:

Peter Ohl, University of Konstanz

Constructor Summary

Comment(NodeSettingsRO settings)
Creates a new Comment object and sets its parameters from the config object.

Comment(String left, String right, boolean returnAsToken, boolean includeInToken)
Creates a new Comment object.

Method Summary

String	getBegin()
String	getEnd()
char	getFirstCharOfBegin()
boolean	includeInToken()
boolean	returnAsSeparateToken()
(package private) void	saveToConfig(NodeSettingsWO cfg) Writes the object into a NodeSettings object.
String	toString() Returns "[begin]...[end], i, r" for block comments, or "[begin] SL, i, r" for single line comments, with 'i' only printed when flag "indcludeInToken" is set, and 'r' only printed when flag "returnAsSeparateToken is set.

Methods inherited from class java.lang.Object

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

Constructor Detail

Comment

public Comment(String left,
               String right,
               boolean returnAsToken,
               boolean includeInToken)

Creates a new Comment object. Only created by the FileTokenizerSettings class.

Parameters:

left - The comment start pattern.

right - The comment end pattern.

returnAsToken - boolean flag.

includeInToken - boolean flag.

See Also:

TokenizerSettings

Comment

Comment(NodeSettingsRO settings)
  throws InvalidSettingsException

Creates a new Comment object and sets its parameters from the config object. If config doesn't contain all necessary parameters or contains inconsistent settings it will throw an IllegalArguments exception

Parameters:

settings - an object the parameters are read from.

Throws:

InvalidSettingsException - if the config is not valid. Huh.

Method Detail

saveToConfig

void saveToConfig(NodeSettingsWO cfg)

Writes the object into a NodeSettings object. If this config object is then used to construct a new Comment this and the new object should be identical.

Parameters:

cfg - a config object the internal values of this object will be stored into.

getBegin

public String getBegin()

Returns:

The begin pattern of this comment.

getEnd

public String getEnd()

Returns:

The end pattern of this comment.

getFirstCharOfBegin

public char getFirstCharOfBegin()

Returns:

The first character of the begin pattern of this comment.

includeInToken

public boolean includeInToken()

Returns:

true if this comment will be included in the current token.

returnAsSeparateToken

public boolean returnAsSeparateToken()

Returns:

true if this comment will be returned as separate token.

toString

public String toString()

Returns "[begin]...[end], i, r" for block comments, or "[begin] SL, i, r" for single line comments, with 'i' only printed when flag "indcludeInToken" is set, and 'r' only printed when flag "returnAsSeparateToken is set.

Overrides:

toString in class Object