Tomcat 10.1.19 · org.apache.tomcat.util.http.fileupload.ParameterParser

Modifier and Type	Field and Description
private char[]	chars String to be parsed.
private int	i1 Start of a token.
private int	i2 End of a token.
private int	len Maximum position in the string.
private boolean	lowerCaseNames Whether names stored in the map should be converted to lower case.
private int	pos Current position in the string.

Access	Constructor and Description
public	ParameterParser() Default ParameterParser constructor.

Method Summary

Modifier and Type	Method and Description
private String	Returns: the token getToken(final boolean `true` if quotation marks are expected, `false` otherwise. quoted) A helper method to process the parsed token.
private boolean	Returns: `true` if there are unparsed characters, `false` otherwise. hasChar() Are there any characters left to parse?
public boolean	Returns: `true` if parameter names are to be converted to lower case when name/value pairs are parsed. Otherwise returns `false` isLowerCaseNames() Returns `true` if parameter names are to be converted to lower case when name/value pairs are parsed.
private boolean	Returns: `true` if the character is present in the array of characters, `false` otherwise. isOneOf(final char the character to test for presence in the array of characters ch, final char[] the array of characters to test against charray) Tests if the given character is present in the array of characters.
public Map<String, String>	Returns: a map of name/value pairs parse(final String the string that contains a sequence of name/value pairs str, final char[] the name/value pairs separators separators) Extracts a map of name/value pairs from the given string.
public Map<String, String>	Returns: a map of name/value pairs parse(final String the string that contains a sequence of name/value pairs str, final char the name/value pairs separator separator) Extracts a map of name/value pairs from the given string.
public Map<String, String>	Returns: a map of name/value pairs parse(final char[] the array of characters that contains a sequence of name/value pairs charArray, final char the name/value pairs separator separator) Extracts a map of name/value pairs from the given array of characters.
public Map<String, String>	Returns: a map of name/value pairs parse(final char[] the array of characters that contains a sequence of name/value pairs charArray, final int - the initial offset. offset, final int - the length. length, final char the name/value pairs separator separator) Extracts a map of name/value pairs from the given array of characters.
private String	Returns: the token parseQuotedToken(final char[] the array of terminating characters. Any of these characters when encountered outside the quotation marks signify the end of the token terminators) Parses out a token until any of the given terminators is encountered outside the quotation marks.
private String	Returns: the token parseToken(final char[] the array of terminating characters. Any of these characters when encountered signify the end of the token terminators) Parses out a token until any of the given terminators is encountered.
public void	setLowerCaseNames(final boolean `true` if parameter names are to be converted to lower case when name/value pairs are parsed. `false` otherwise. b) Sets the flag if parameter names are to be converted to lower case when name/value pairs are parsed.

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

chars	back to summary
private char[] chars String to be parsed.

i1	back to summary
private int i1 Start of a token.

i2	back to summary
private int i2 End of a token.

len	back to summary
private int len Maximum position in the string.

lowerCaseNames	back to summary
private boolean lowerCaseNames Whether names stored in the map should be converted to lower case.

pos	back to summary
private int pos Current position in the string.

ParameterParser	back to summary
public ParameterParser() Default ParameterParser constructor.

Method Detail

getToken back to summary

getToken	back to summary
private String getToken(final boolean quoted) A helper method to process the parsed token. This method removes leading and trailing blanks as well as enclosing quotation marks, when necessary. Parameters quoted:boolean `true` if quotation marks are expected, `false` otherwise. Returns:String the token

private String getToken(final boolean quoted)

A helper method to process the parsed token. This method removes leading and trailing blanks as well as enclosing quotation marks, when necessary.

Parameters

quoted:boolean: true if quotation marks are expected, false otherwise.

Returns:String

the token

hasChar back to summary

hasChar	back to summary
private boolean hasChar() Are there any characters left to parse? Returns:boolean `true` if there are unparsed characters, `false` otherwise.

private boolean hasChar()

Are there any characters left to parse?

Returns:boolean: true if there are unparsed characters, false otherwise.

isLowerCaseNames back to summary

isLowerCaseNames	back to summary
public boolean isLowerCaseNames() Returns `true` if parameter names are to be converted to lower case when name/value pairs are parsed. Returns:boolean `true` if parameter names are to be converted to lower case when name/value pairs are parsed. Otherwise returns `false`

public boolean isLowerCaseNames()

Returns true if parameter names are to be converted to lower case when name/value pairs are parsed.

Returns:boolean: true if parameter names are to be converted to lower case when name/value pairs are parsed. Otherwise returns false

isOneOf back to summary

isOneOf	back to summary
private boolean isOneOf(final char ch, final char[] charray) Tests if the given character is present in the array of characters. Parameters ch:char the character to test for presence in the array of characters charray:char[] the array of characters to test against Returns:boolean `true` if the character is present in the array of characters, `false` otherwise.

private boolean isOneOf(final char ch, final char[] charray)

Tests if the given character is present in the array of characters.

Parameters

ch:char: the character to test for presence in the array of characters
charray:char[]: the array of characters to test against

Returns:boolean

true if the character is present in the array of characters, false otherwise.

parse	back to summary
public Map<String, String> parse(final String str, final char[] separators) Extracts a map of name/value pairs from the given string. Names are expected to be unique. Multiple separators may be specified and the earliest found in the input string is used. Parameters str:String the string that contains a sequence of name/value pairs separators:char[] the name/value pairs separators Returns:Map<String, String> a map of name/value pairs

parse

back to summary

public Map<String, String> parse(final String str, final char[] separators)

Extracts a map of name/value pairs from the given string. Names are expected to be unique. Multiple separators may be specified and the earliest found in the input string is used.

Parameters

str:String: the string that contains a sequence of name/value pairs
separators:char[]: the name/value pairs separators

Returns:Map<String, String>

a map of name/value pairs

parse	back to summary
public Map<String, String> parse(final String str, final char separator) Extracts a map of name/value pairs from the given string. Names are expected to be unique. Parameters str:String the string that contains a sequence of name/value pairs separator:char the name/value pairs separator Returns:Map<String, String> a map of name/value pairs

parse

back to summary

public Map<String, String> parse(final String str, final char separator)

Extracts a map of name/value pairs from the given string. Names are expected to be unique.

Parameters

str:String: the string that contains a sequence of name/value pairs
separator:char: the name/value pairs separator

Returns:Map<String, String>

a map of name/value pairs

parse	back to summary
public Map<String, String> parse(final char[] charArray, final char separator) Extracts a map of name/value pairs from the given array of characters. Names are expected to be unique. Parameters charArray:char[] the array of characters that contains a sequence of name/value pairs separator:char the name/value pairs separator Returns:Map<String, String> a map of name/value pairs

parse

back to summary

public Map<String, String> parse(final char[] charArray, final char separator)

Extracts a map of name/value pairs from the given array of characters. Names are expected to be unique.

Parameters

charArray:char[]: the array of characters that contains a sequence of name/value pairs
separator:char: the name/value pairs separator

Returns:Map<String, String>

a map of name/value pairs

parse	back to summary
public Map<String, String> parse(final char[] charArray, final int offset, final int length, final char separator) Extracts a map of name/value pairs from the given array of characters. Names are expected to be unique. Parameters charArray:char[] the array of characters that contains a sequence of name/value pairs offset:int - the initial offset. length:int - the length. separator:char the name/value pairs separator Returns:Map<String, String> a map of name/value pairs

parse

back to summary

public Map<String, String> parse(final char[] charArray, final int offset, final int length, final char separator)

Extracts a map of name/value pairs from the given array of characters. Names are expected to be unique.

Parameters

charArray:char[]: the array of characters that contains a sequence of name/value pairs
offset:int: - the initial offset.
length:int: - the length.
separator:char: the name/value pairs separator

Returns:Map<String, String>

a map of name/value pairs

parseQuotedToken	back to summary
private String parseQuotedToken(final char[] terminators) Parses out a token until any of the given terminators is encountered outside the quotation marks. Parameters terminators:char[] the array of terminating characters. Any of these characters when encountered outside the quotation marks signify the end of the token Returns:String the token

parseQuotedToken

back to summary

private String parseQuotedToken(final char[] terminators)

Parses out a token until any of the given terminators is encountered outside the quotation marks.

Parameters

terminators:char[]: the array of terminating characters. Any of these characters when encountered outside the quotation marks signify the end of the token

Returns:String

the token

parseToken	back to summary
private String parseToken(final char[] terminators) Parses out a token until any of the given terminators is encountered. Parameters terminators:char[] the array of terminating characters. Any of these characters when encountered signify the end of the token Returns:String the token

parseToken

back to summary

private String parseToken(final char[] terminators)

Parses out a token until any of the given terminators is encountered.

Parameters

terminators:char[]: the array of terminating characters. Any of these characters when encountered signify the end of the token

Returns:String

the token

setLowerCaseNames back to summary

setLowerCaseNames	back to summary
public void setLowerCaseNames(final boolean b) Sets the flag if parameter names are to be converted to lower case when name/value pairs are parsed. Parameters b:boolean `true` if parameter names are to be converted to lower case when name/value pairs are parsed. `false` otherwise.

public void setLowerCaseNames(final boolean b)

Sets the flag if parameter names are to be converted to lower case when name/value pairs are parsed.

Parameters

b:boolean: true if parameter names are to be converted to lower case when name/value pairs are parsed. false otherwise.

public Class ParameterParser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail