|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.Writer
java.io.StringWriter
org.restlet.engine.header.HeaderWriter<V>
V
- The value type.public abstract class HeaderWriter<V>
HTTP-style header writer.
Field Summary |
---|
Fields inherited from class java.io.Writer |
---|
lock |
Constructor Summary | |
---|---|
HeaderWriter()
|
Method Summary | |
---|---|
HeaderWriter<V> |
append(char c)
|
HeaderWriter<V> |
append(char[] cs)
Appends an array of characters. |
HeaderWriter<V> |
append(CharSequence csq)
|
HeaderWriter<V> |
append(Collection<V> values)
Appends a collection of values. |
HeaderWriter<V> |
append(int i)
Appends an integer. |
HeaderWriter<V> |
append(long l)
Appends a long. |
abstract HeaderWriter<V> |
append(V value)
Appends a value. |
HeaderWriter<V> |
appendComment(String content)
Appends a string as an HTTP comment, surrounded by parenthesis and with quoted pairs if needed. |
HeaderWriter<V> |
appendExtension(NamedValue<String> extension)
Formats and appends a parameter as an extension. |
HeaderWriter<V> |
appendExtension(String name,
String value)
Appends an extension. |
HeaderWriter<V> |
appendParameterSeparator()
Appends a semicolon as a parameter separator. |
HeaderWriter<V> |
appendProduct(String name,
String version)
Appends a product description. |
HeaderWriter<V> |
appendQuotedPair(char character)
Appends a quoted character, prefixing it with a backslash. |
HeaderWriter<V> |
appendQuotedString(String content)
Appends a quoted string. |
HeaderWriter<V> |
appendSpace()
Appends a space character. |
HeaderWriter<V> |
appendToken(String token)
Appends a token. |
HeaderWriter<V> |
appendUriEncoded(CharSequence source,
CharacterSet characterSet)
Formats and appends a source string as an URI encoded string. |
HeaderWriter<V> |
appendValueSeparator()
Appends a comma as a value separator. |
protected boolean |
canWrite(V value)
Indicates if the value can be written to the header. |
Methods inherited from class java.io.StringWriter |
---|
append, close, flush, getBuffer, toString, write, write, write, write |
Methods inherited from class java.io.Writer |
---|
write |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public HeaderWriter()
Method Detail |
---|
public HeaderWriter<V> append(char c)
append
in interface Appendable
append
in class StringWriter
public HeaderWriter<V> append(char[] cs)
cs
- The array of characters.
public HeaderWriter<V> append(CharSequence csq)
append
in interface Appendable
append
in class StringWriter
public HeaderWriter<V> append(Collection<V> values)
values
- The collection of values to append.
public HeaderWriter<V> append(int i)
i
- The value to append.
public HeaderWriter<V> append(long l)
l
- The value to append.
public abstract HeaderWriter<V> append(V value)
value
- The value.
public HeaderWriter<V> appendComment(String content)
content
- The comment to write.
public HeaderWriter<V> appendExtension(NamedValue<String> extension)
extension
- The parameter to format as an extension.
public HeaderWriter<V> appendExtension(String name, String value)
name
- The extension name.value
- The extension value.
public HeaderWriter<V> appendParameterSeparator()
public HeaderWriter<V> appendProduct(String name, String version)
name
- The product name token.version
- The product version token.
public HeaderWriter<V> appendQuotedPair(char character)
character
- The character to quote.
public HeaderWriter<V> appendQuotedString(String content)
content
- The string to quote and write.
public HeaderWriter<V> appendSpace()
public HeaderWriter<V> appendToken(String token)
token
- The token to write.
public HeaderWriter<V> appendUriEncoded(CharSequence source, CharacterSet characterSet)
source
- The source string to format.characterSet
- The supported character encoding.
public HeaderWriter<V> appendValueSeparator()
protected boolean canWrite(V value)
Encoding.IDENTITY
constants for example. By
default it returns true for non null values.
value
- The value to add.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |