|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.microsoft.tfs.core.httpclient.util.ParameterFormatter
public class ParameterFormatter
This formatter produces a textual representation of attribute/value pairs. It comforms to the generic grammar and formatting rules outlined in the Section 2.1 and Section 3.6 of RFC 2616
Many HTTP/1.1 header field values consist of words separated by LWS or special characters. These special characters MUST be in a quoted string to be used within a parameter value (as defined in section 3.6).
token = 1*separators = "(" | ")" | "<" | ">" | "@" | "," | ";" | ":" | "\" | <"> | "/" | "[" | "]" | "?" | "=" | "{" | "}" | SP | HT
A string of text is parsed as a single word if it is quoted using double-quote marks.
quoted-string = ( <"> *(qdtext | quoted-pair ) <"> ) qdtext =>
The backslash character ("\") MAY be used as a single-character quoting mechanism only within quoted-string and comment constructs.
quoted-pair = "\" CHAR
Parameters are in the form of attribute/value pairs.
parameter = attribute "=" value attribute = token value = token | quoted-string
Constructor Summary | |
---|---|
ParameterFormatter()
Default ParameterFormatter constructor |
Method Summary | |
---|---|
java.lang.String |
format(NameValuePair param)
Produces textual representaion of the attribute/value pair using formatting rules defined in RFC 2616 |
void |
format(java.lang.StringBuffer buffer,
NameValuePair param)
Produces textual representaion of the attribute/value pair using formatting rules defined in RFC 2616 |
static void |
formatValue(java.lang.StringBuffer buffer,
java.lang.String value,
boolean alwaysUseQuotes)
Formats the given parameter value using formatting rules defined in RFC 2616 |
boolean |
isAlwaysUseQuotes()
Determines whether all parameter values must be enclosed in quotation marks, even if they do not contain any special characters |
void |
setAlwaysUseQuotes(boolean alwaysUseQuotes)
Defines whether all parameter values must be enclosed in quotation marks, even if they do not contain any special characters |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ParameterFormatter()
Method Detail |
---|
public boolean isAlwaysUseQuotes()
public void setAlwaysUseQuotes(boolean alwaysUseQuotes)
alwaysUseQuotes
- public static void formatValue(java.lang.StringBuffer buffer, java.lang.String value, boolean alwaysUseQuotes)
buffer
- output buffervalue
- the parameter value to be formattedalwaysUseQuotes
- true if the parameter value must be enclosed in quotation
marks, even if it does not contain any special characters
, false only if the parameter value contains potentially
unsafe special characterspublic void format(java.lang.StringBuffer buffer, NameValuePair param)
buffer
- output bufferparam
- the parameter to be formattedpublic java.lang.String format(NameValuePair param)
param
- the parameter to be formatted
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |