net.sf.xslthl.highlighters
Class HeredocHighlighter

java.lang.Object
  net.sf.xslthl.Highlighter
      net.sf.xslthl.highlighters.HeredocHighlighter

public class HeredocHighlighter
extends Highlighter

Accepts heredoc constructions. Accepted parameters:

start

How the heredoc construction starts. Required.

quote

Allowed quote characters to be used in the identifier name. This parameter can be used more than once.

noWhiteSpace

whitespace after start is not allowed.

looseTerminator

if set the identifier does not have to start on a new line

flag

Flags that can be put after the 'start'. This parameter can be used more than once.

See http://en.wikipedia.org/wiki/Heredoc

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.xslthl.Highlighter

Highlighter.IgnoreCaseComparator

Field Summary

protected Set<String>	flags
protected boolean	indentFlag
protected boolean	looseTerminator
protected boolean	noWhiteSpace
protected Set<String>	quoteChar quote characters that can be used in the heredoc identifier
protected String	start The token that initiates a heredoc construction

Fields inherited from class net.sf.xslthl.Highlighter

styleName, XMLname

Constructor Summary

HeredocHighlighter()

Method Summary

String	getDefaultStyle() The default style name
boolean	highlight(CharIter in, List<Block> out) Perform highlighting on the current token stream.
void	init(Params params) Initializer
boolean	startsWith(CharIter in) return true if the current character is a possible match for this highlighter

Methods inherited from class net.sf.xslthl.Highlighter

isNewLine, reset

Methods inherited from class java.lang.Object

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

Field Detail

start

protected String start

The token that initiates a heredoc construction

quoteChar

protected Set<String> quoteChar

quote characters that can be used in the heredoc identifier

noWhiteSpace

protected boolean noWhiteSpace

looseTerminator

protected boolean looseTerminator

indentFlag

protected boolean indentFlag

flags

protected Set<String> flags

Constructor Detail

HeredocHighlighter

public HeredocHighlighter()

Method Detail

init

public void init(Params params)
          throws HighlighterConfigurationException

Description copied from class: Highlighter

Initializer

Overrides:

init in class Highlighter

Throws:

HighlighterConfigurationException

startsWith

public boolean startsWith(CharIter in)

Description copied from class: Highlighter

return true if the current character is a possible match for this highlighter

Overrides:

startsWith in class Highlighter

Returns:

highlight

public boolean highlight(CharIter in,
                         List<Block> out)

Description copied from class: Highlighter

Perform highlighting on the current token stream. Return true when highlighting was performed, or false in case of a false positive.

Specified by:

highlight in class Highlighter

Returns:

getDefaultStyle

public String getDefaultStyle()

Description copied from class: Highlighter

The default style name

Specified by:

getDefaultStyle in class Highlighter

Returns: