Modifier and Type	Class and Description
public static class	QuotedStringTokenizer.Builder

Modifier and Type	Field and Description
public static final QuotedStringTokenizer	CSV A QuotedStringTokenizer for comma separated values with optional white space.

Modifier and Type	Method and Description
public static QuotedStringTokenizer.Builder	Returns: A Builder for a `QuotedStringTokenizer`. builder()
public static boolean	Returns: True if the string is quoted. isQuoted(String The string to test s)
public boolean	Returns: True if a string containing the character should be quoted. needsQuoting(char A character c)
public default String	Returns: quoted string quote(String The string to quote. s) Quote a string.
public void	quote(Appendable The Appendable to append the quoted and escaped string into. buffer, String The String to quote. input) Quote a string into an Appendable, escaping any characters that need to be escaped.
public String	Returns: quoted string quoteIfNeeded(String The string to quote. s) Quote a string.
public void	quoteIfNeeded(StringBuilder the buffer to append to buf, String the string to possibly quote str) Append into buf the provided string, adding quotes if needed.
public Iterator<String>	Returns: An iterator of token strings. tokenize(String The string to be tokenized string) Tokenize the passed string into an `Iterator` of tokens split from the string by delimiters.
public String	Returns: unquoted string with escaped characters expanded. unquote(String The string to unquote. s) Unquote a string and expand any escaped characters

CSV	back to summary
public static final QuotedStringTokenizer CSV A QuotedStringTokenizer for comma separated values with optional white space.

Method Detail

builder	back to summary
public static QuotedStringTokenizer.Builder builder() Returns:QuotedStringTokenizer.Builder A Builder for a `QuotedStringTokenizer`.

isQuoted	back to summary
public static boolean isQuoted(String s) Parameters s:String The string to test Returns:boolean True if the string is quoted.

needsQuoting	back to summary
public boolean needsQuoting(char c) Parameters c:char A character Returns:boolean True if a string containing the character should be quoted.

quote	back to summary
public default String quote(String s) Quote a string. The string is quoted only if quoting is required due to embedded delimiters, quote characters or the empty string. Parameters s:String The string to quote. Returns:String quoted string

quote

back to summary

public default String quote(String s)

Quote a string. The string is quoted only if quoting is required due to embedded delimiters, quote characters or the empty string.

Parameters

s:String: The string to quote.

Returns:String

quoted string

quote	back to summary
public void quote(Appendable buffer, String input) Quote a string into an Appendable, escaping any characters that need to be escaped. Parameters buffer:Appendable The Appendable to append the quoted and escaped string into. input:String The String to quote.

quote

back to summary

public void quote(Appendable buffer, String input)

Quote a string into an Appendable, escaping any characters that need to be escaped.

Parameters

buffer:Appendable: The Appendable to append the quoted and escaped string into.
input:String: The String to quote.

quoteIfNeeded	back to summary
public String quoteIfNeeded(String s) Quote a string. The string is quoted only if quoting is required due to embedded delimiters, quote characters or the empty string. Parameters s:String The string to quote. Returns:String quoted string

quoteIfNeeded

back to summary

public String quoteIfNeeded(String s)

Quote a string. The string is quoted only if quoting is required due to embedded delimiters, quote characters or the empty string.

Parameters

s:String: The string to quote.

Returns:String

quoted string

quoteIfNeeded back to summary

quoteIfNeeded	back to summary
public void quoteIfNeeded(StringBuilder buf, String str) Append into buf the provided string, adding quotes if needed. Quoting is determined if any of the characters in the `delim` are found in the input `str`. Parameters buf:StringBuilder the buffer to append to str:String the string to possibly quote

public void quoteIfNeeded(StringBuilder buf, String str)

Append into buf the provided string, adding quotes if needed.

Quoting is determined if any of the characters in the delim are found in the input str.

Parameters

buf:StringBuilder: the buffer to append to
str:String: the string to possibly quote

tokenize back to summary

tokenize	back to summary
public Iterator<String> tokenize(String string) Tokenize the passed string into an `Iterator` of tokens split from the string by delimiters. Tokenization is done as the iterator is advanced. Parameters string:String The string to be tokenized Returns:Iterator<String> An iterator of token strings.

public Iterator<String> tokenize(String string)

Tokenize the passed string into an Iterator of tokens split from the string by delimiters. Tokenization is done as the iterator is advanced.

Parameters

string:String: The string to be tokenized

Returns:Iterator<String>

An iterator of token strings.

unquote	back to summary
public String unquote(String s) Unquote a string and expand any escaped characters Parameters s:String The string to unquote. Returns:String unquoted string with escaped characters expanded.

unquote

back to summary

public String unquote(String s)

Unquote a string and expand any escaped characters

Parameters

s:String: The string to unquote.

Returns:String

unquoted string with escaped characters expanded.

org.eclipse.jetty.util back to summary

public Class QuotedStringTokenizer.Builder

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jetty.util.QuotedStringTokenizer.Builder

Field Summary

Modifier and Type	Field and Description
private String	_delim
private boolean	_embeddedQuotes
private boolean	_escapeOnlyQuote
private boolean	_legacy
private boolean	_optionalWhiteSpace
private boolean	_returnDelimiters
private boolean	_returnQuotes
private boolean	_singleQuotes

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
public QuotedStringTokenizer.Builder	Returns: this `Builder` allowEmbeddedQuotes() If called, the built `QuotedStringTokenizer` will interpret quote characters within a token as initiating a sequence of quoted characters, rather than being part of the token value itself.
public QuotedStringTokenizer.Builder	Returns: this `Builder` allowEscapeOnlyForQuotes() If called, the built `QuotedStringTokenizer` will only allow escapes to be used with the quote character.
public QuotedStringTokenizer.Builder	Returns: this `Builder` allowSingleQuote() If called, the built `QuotedStringTokenizer` will allow quoting with the single quote character `'`.
public QuotedStringTokenizer	Returns: The built immutable `QuotedStringTokenizer`. build()
public QuotedStringTokenizer.Builder	Returns: this `Builder` delimiters(String A string containing the set of characters that are considered delimiters. delim)
public QuotedStringTokenizer.Builder	Returns: this `Builder` ignoreOptionalWhiteSpace() If called, the built `QuotedStringTokenizer` will ignore optional white space characters before and after delimiters.
public QuotedStringTokenizer.Builder	Returns: this `Builder` legacy() If called, the built `QuotedStringTokenizer` will use the legacy implementation from prior to jetty-12.
public QuotedStringTokenizer.Builder	Returns: this `Builder` returnDelimiters() If called, the built `QuotedStringTokenizer` will return delimiter characters as individual tokens.
public QuotedStringTokenizer.Builder	Returns: this `Builder` returnQuotes() If called, the built `QuotedStringTokenizer` will return tokens with quotes interpreted but not removed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_delim	back to summary
private String _delim

_embeddedQuotes	back to summary
private boolean _embeddedQuotes

_escapeOnlyQuote	back to summary
private boolean _escapeOnlyQuote

_legacy	back to summary
private boolean _legacy

_optionalWhiteSpace	back to summary
private boolean _optionalWhiteSpace

_returnDelimiters	back to summary
private boolean _returnDelimiters

_returnQuotes	back to summary
private boolean _returnQuotes

_singleQuotes	back to summary
private boolean _singleQuotes

Constructor Detail

Builder	back to summary
private Builder()

Method Detail

allowEmbeddedQuotes back to summary

allowEmbeddedQuotes	back to summary
public QuotedStringTokenizer.Builder allowEmbeddedQuotes() If called, the built `QuotedStringTokenizer` will interpret quote characters within a token as initiating a sequence of quoted characters, rather than being part of the token value itself. For example the string `name1=value1; name2="value;2"` with `;` delimiter, would result in two tokens: `name1=value1` and `name2=value;2`. Without this option the result would be three tokens: `name1=value1`, `name2="value` and `2"`. Returns:QuotedStringTokenizer.Builder this `Builder`

public QuotedStringTokenizer.Builder allowEmbeddedQuotes()

If called, the built QuotedStringTokenizer will interpret quote characters within a token as initiating a sequence of quoted characters, rather than being part of the token value itself. For example the string name1=value1; name2="value;2" with ; delimiter, would result in two tokens: name1=value1 and name2=value;2. Without this option the result would be three tokens: name1=value1, name2="value and 2".

Returns:QuotedStringTokenizer.Builder: this Builder

allowEscapeOnlyForQuotes back to summary

allowEscapeOnlyForQuotes	back to summary
public QuotedStringTokenizer.Builder allowEscapeOnlyForQuotes() If called, the built `QuotedStringTokenizer` will only allow escapes to be used with the quote character. Specifically the escape character itself cannot be escaped. Any usage of the escape character, other than for quotes, is considered as a literal escape character. For example the string `"test\"tokenizer\test"` will be unquoted as `test"tokenizer\test`. Returns:QuotedStringTokenizer.Builder this `Builder`

public QuotedStringTokenizer.Builder allowEscapeOnlyForQuotes()

If called, the built QuotedStringTokenizer will only allow escapes to be used with the quote character. Specifically the escape character itself cannot be escaped. Any usage of the escape character, other than for quotes, is considered as a literal escape character. For example the string "test\"tokenizer\test" will be unquoted as test"tokenizer\test.

Returns:QuotedStringTokenizer.Builder: this Builder

allowSingleQuote back to summary

allowSingleQuote	back to summary
public QuotedStringTokenizer.Builder allowSingleQuote() If called, the built `QuotedStringTokenizer` will allow quoting with the single quote character `'`. This can only be used with `legacy()`. Returns:QuotedStringTokenizer.Builder this `Builder`

public QuotedStringTokenizer.Builder allowSingleQuote()

If called, the built QuotedStringTokenizer will allow quoting with the single quote character '. This can only be used with legacy().

Returns:QuotedStringTokenizer.Builder: this Builder

build	back to summary
public QuotedStringTokenizer build() Returns:QuotedStringTokenizer The built immutable `QuotedStringTokenizer`.

delimiters	back to summary
public QuotedStringTokenizer.Builder delimiters(String delim) Parameters delim:String A string containing the set of characters that are considered delimiters. Returns:QuotedStringTokenizer.Builder this `Builder`

ignoreOptionalWhiteSpace back to summary

ignoreOptionalWhiteSpace	back to summary
public QuotedStringTokenizer.Builder ignoreOptionalWhiteSpace() If called, the built `QuotedStringTokenizer` will ignore optional white space characters before and after delimiters. This is not supported together with `legacy()`. For example, the string `a, b ,c` with delimiter `,` will be tokenized with this option as `a`, `b` and `c`, all trimmed of spaces. Without this option, the second token would be `b` with one space before and after. Returns:QuotedStringTokenizer.Builder this `Builder`

public QuotedStringTokenizer.Builder ignoreOptionalWhiteSpace()

If called, the built QuotedStringTokenizer will ignore optional white space characters before and after delimiters. This is not supported together with legacy(). For example, the string a, b ,c with delimiter , will be tokenized with this option as a, b and c, all trimmed of spaces. Without this option, the second token would be b with one space before and after.

Returns:QuotedStringTokenizer.Builder: this Builder

legacy back to summary

legacy	back to summary
public QuotedStringTokenizer.Builder legacy() If called, the built `QuotedStringTokenizer` will use the legacy implementation from prior to jetty-12. The legacy implementation does not comply with any current RFC. Using `legacy` also implies `allowEmbeddedQuotes()`. Returns:QuotedStringTokenizer.Builder this `Builder`

public QuotedStringTokenizer.Builder legacy()

If called, the built QuotedStringTokenizer will use the legacy implementation from prior to jetty-12. The legacy implementation does not comply with any current RFC. Using legacy also implies allowEmbeddedQuotes().

Returns:QuotedStringTokenizer.Builder: this Builder

returnDelimiters back to summary

returnDelimiters	back to summary
public QuotedStringTokenizer.Builder returnDelimiters() If called, the built `QuotedStringTokenizer` will return delimiter characters as individual tokens. Returns:QuotedStringTokenizer.Builder this `Builder`

public QuotedStringTokenizer.Builder returnDelimiters()

If called, the built QuotedStringTokenizer will return delimiter characters as individual tokens.

Returns:QuotedStringTokenizer.Builder: this Builder

returnQuotes back to summary

returnQuotes	back to summary
public QuotedStringTokenizer.Builder returnQuotes() If called, the built `QuotedStringTokenizer` will return tokens with quotes interpreted but not removed. Returns:QuotedStringTokenizer.Builder this `Builder`

public QuotedStringTokenizer.Builder returnQuotes()

If called, the built QuotedStringTokenizer will return tokens with quotes interpreted but not removed.

Returns:QuotedStringTokenizer.Builder: this Builder

public Interface QuotedStringTokenizer

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Class QuotedStringTokenizer.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail