net.sf.mmm.util.lang.base

Class StringSyntaxBean

java.lang.Object

net.sf.mmm.util.lang.base.StringSyntaxBean

All Implemented Interfaces:

StringSyntax

Direct Known Subclasses:

AbstractCharScannerSyntax

public class StringSyntaxBean
extends Object
implements StringSyntax

This is the implementation of StringSyntax as simple Java bean.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private char	escape
private char	quoteEnd
private char	quoteStart

Constructor Summary

Constructors

Constructor and Description
StringSyntaxBean() The constructor.
StringSyntaxBean(char escape) The constructor.
StringSyntaxBean(char escape, char quote) The constructor.
StringSyntaxBean(char escape, char quoteStart, char quoteEnd) The constructor.

Method Summary

Modifier and Type	Method and Description
char	getEscape() This method gets the character used as escape.
char	getQuoteEnd() This method gets the character used to end a quotation.
char	getQuoteStart() This method gets the character used to start a quotation that should be terminated by a quote-end character.
void	setEscape(char escape)
void	setQuote(char quote) This method sets both the quote-start and quote-end character.
void	setQuoteEnd(char quoteEnd)
void	setQuoteStart(char quoteStart)

Methods inherited from class java.lang.Object

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

Field Detail

escape

private char escape

quoteStart

private char quoteStart

quoteEnd

private char quoteEnd

Constructor Detail

StringSyntaxBean

public StringSyntaxBean()

The constructor.

StringSyntaxBean

public StringSyntaxBean(char escape)

The constructor.

Parameters:

escape - - see getEscape().

StringSyntaxBean

public StringSyntaxBean(char escape,
                        char quote)

The constructor.

Parameters:

escape - - see getEscape().

quote - - see setQuote(char).

StringSyntaxBean

public StringSyntaxBean(char escape,
                        char quoteStart,
                        char quoteEnd)

The constructor.

Parameters:

escape - - see getEscape().

quoteStart - - see getQuoteStart().

quoteEnd - - see @getQuoteEnd().

Method Detail

getEscape

public char getEscape()

Description copied from interface: StringSyntax

This method gets the character used as escape. It is used to mark special characters like StringSyntax.getQuoteStart() to allow these characters also in the payload. The escape itself is removed on decoding while the next character is taken as is without any special interpretation.
The most common escape character is the backslash (\).
Here are some examples for decoding:

escape	input	output
\	a\b\\c	ab\c
~	a~b~~~c	ab~c

Specified by:

getEscape in interface StringSyntax

Returns:

the escape character or '\0' for no escaping.

setEscape

public void setEscape(char escape)

Parameters:

escape - is the escape to set.

getQuoteStart

public char getQuoteStart()

Description copied from interface: StringSyntax

This method gets the character used to start a quotation that should be terminated by a quote-end character. The text inside the quote is taken as is (without the quote characters).
Common examples for quote characters are the single quotes (') and double quotes (").

Specified by:

getQuoteStart in interface StringSyntax

Returns:

the character used to start a quotation or '\0' to disable.

setQuoteStart

public void setQuoteStart(char quoteStart)

Parameters:

quoteStart - is the quoteStart to set.

getQuoteEnd

public char getQuoteEnd()

Description copied from interface: StringSyntax

This method gets the character used to end a quotation.

Specified by:

getQuoteEnd in interface StringSyntax

Returns:

the character used to end a quotation or '\0' to disable.

See Also:

StringSyntax.getQuoteStart()

setQuoteEnd

public void setQuoteEnd(char quoteEnd)

Parameters:

quoteEnd - is the quoteEnd to set.

setQuote

public void setQuote(char quote)

This method sets both the quote-start and quote-end character.

Parameters:

quote - the quote character to set.