|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.trolltech.qt.QSignalEmitter
com.trolltech.qt.QtJambiObject
com.trolltech.qt.network.QHttpHeader
public abstract class QHttpHeader
The QHttpHeader class contains header information for HTTP.
In most cases you should use the more specialized derivatives of this class, QHttpResponseHeader and QHttpRequestHeader, rather than directly using QHttpHeader.
QHttpHeader provides the HTTP header fields. A HTTP header field consists of a name followed by a colon, a single space, and the field value. (See RFC 1945.) Field names are case-insensitive. A typical header field looks like this:
content-type: text/html
In the API the header field name is called the "key" and the content is called the "value". You can get and set a header field's value by using its key with value and setValue, e.g.
header.setValue("content-type", "text/html"); QString contentType = header.value("content-type");
Some fields are so common that getters and setters are provided for them as a convenient alternative to using value and setValue, e.g. contentLength and contentType, setContentLength and setContentType.
Each header key has a single value associated with it. If you set the value for a key which already exists the previous value will be discarded.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter |
---|
QSignalEmitter.AbstractSignal, QSignalEmitter.Signal0, QSignalEmitter.Signal1<A>, QSignalEmitter.Signal2<A,B>, QSignalEmitter.Signal3<A,B,C>, QSignalEmitter.Signal4<A,B,C,D>, QSignalEmitter.Signal5<A,B,C,D,E>, QSignalEmitter.Signal6<A,B,C,D,E,F>, QSignalEmitter.Signal7<A,B,C,D,E,F,G>, QSignalEmitter.Signal8<A,B,C,D,E,F,G,H>, QSignalEmitter.Signal9<A,B,C,D,E,F,G,H,I> |
Constructor Summary | |
---|---|
QHttpHeader()
Constructs an empty HTTP header. |
|
QHttpHeader(QHttpHeader header)
Constructs a copy of header. |
|
QHttpHeader(java.lang.String str)
Constructs a HTTP header for str. |
Method Summary | |
---|---|
void |
addValue(java.lang.String key,
java.lang.String value)
Adds a new entry with the key and value. |
java.util.List<java.lang.String> |
allValues(java.lang.String key)
Returns all the entries with the given key. |
int |
contentLength()
Returns the value of the special HTTP header field content-length. |
java.lang.String |
contentType()
Returns the value of the special HTTP header field content-type. |
static QHttpHeader |
fromNativePointer(QNativePointer nativePointer)
This function returns the QHttpHeader instance pointed to by nativePointer |
boolean |
hasContentLength()
Returns true if the header has an entry for the special HTTP header field content-length; otherwise returns false. |
boolean |
hasContentType()
Returns true if the header has an entry for the the special HTTP header field content-type; otherwise returns false. |
boolean |
hasKey(java.lang.String key)
Returns true if the HTTP header has an entry with the given key; otherwise returns false. |
boolean |
isValid()
Returns true if the HTTP header is valid; otherwise returns false. |
java.util.List<java.lang.String> |
keys()
Returns a list of the keys in the HTTP header. |
abstract int |
majorVersion()
Returns the major protocol-version of the HTTP header. |
abstract int |
minorVersion()
Returns the minor protocol-version of the HTTP header. |
protected boolean |
parse(java.lang.String str)
|
protected boolean |
parseLine(java.lang.String line,
int number)
|
void |
removeAllValues(java.lang.String key)
Removes all the entries with the key key from the HTTP header. |
void |
removeValue(java.lang.String key)
Removes the entry with the key key from the HTTP header. |
void |
setContentLength(int len)
Sets the value of the special HTTP header field content-length to len. |
void |
setContentType(java.lang.String type)
Sets the value of the special HTTP header field content-type to type. |
protected void |
setValid(boolean arg__1)
|
void |
setValue(java.lang.String key,
java.lang.String value)
Sets the value of the entry with the key to value. |
void |
setValues(java.util.List<QPair<java.lang.String,java.lang.String>> values)
Sets the header entries to be the list of key value pairs in values. |
java.lang.String |
toString()
Returns a string representation of the HTTP header. |
java.lang.String |
value(java.lang.String key)
Returns the first value for the entry with the given key. |
java.util.List<QPair<java.lang.String,java.lang.String>> |
values()
Returns all the entries in the header. |
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Constructor Detail |
---|
public QHttpHeader(QHttpHeader header)
Constructs a copy of header.
public QHttpHeader(java.lang.String str)
Constructs a HTTP header for str.
This constructor parses the string str for header fields and adds this information. The str should consist of one or more "\r\n" delimited lines; each of these lines should have the format key, colon, space, value.
public QHttpHeader()
Constructs an empty HTTP header.
Method Detail |
---|
public final void addValue(java.lang.String key, java.lang.String value)
Adds a new entry with the key and value.
public final java.util.List<java.lang.String> allValues(java.lang.String key)
Returns all the entries with the given key. If no entry has this key, an empty string list is returned.
public final int contentLength()
Returns the value of the special HTTP header field content-length.
public final java.lang.String contentType()
Returns the value of the special HTTP header field content-type.
public final boolean hasContentLength()
Returns true if the header has an entry for the special HTTP header field content-length; otherwise returns false.
public final boolean hasContentType()
Returns true if the header has an entry for the the special HTTP header field content-type; otherwise returns false.
public final boolean hasKey(java.lang.String key)
Returns true if the HTTP header has an entry with the given key; otherwise returns false.
public final boolean isValid()
Returns true if the HTTP header is valid; otherwise returns false.
A QHttpHeader is invalid if it was created by parsing a malformed string.
public final java.util.List<java.lang.String> keys()
Returns a list of the keys in the HTTP header.
protected final boolean parse(java.lang.String str)
public final void removeAllValues(java.lang.String key)
Removes all the entries with the key key from the HTTP header.
public final void removeValue(java.lang.String key)
Removes the entry with the key key from the HTTP header.
public final void setContentLength(int len)
Sets the value of the special HTTP header field content-length to len.
public final void setContentType(java.lang.String type)
Sets the value of the special HTTP header field content-type to type.
protected final void setValid(boolean arg__1)
public final void setValue(java.lang.String key, java.lang.String value)
Sets the value of the entry with the key to value.
If no entry with key exists, a new entry with the given key and value is created. If an entry with the key already exists, the first value is discarded and replaced with the given value.
public final void setValues(java.util.List<QPair<java.lang.String,java.lang.String>> values)
public final java.lang.String value(java.lang.String key)
Returns the first value for the entry with the given key. If no entry has this key, an empty string is returned.
public final java.util.List<QPair<java.lang.String,java.lang.String>> values()
Returns all the entries in the header.
public abstract int majorVersion()
Returns the major protocol-version of the HTTP header.
public abstract int minorVersion()
Returns the minor protocol-version of the HTTP header.
protected boolean parseLine(java.lang.String line, int number)
public java.lang.String toString()
Returns a string representation of the HTTP header.
The string is suitable for use by the constructor that takes a QString. It consists of lines with the format: key, colon, space, value, "\r\n".
toString
in class java.lang.Object
public static QHttpHeader fromNativePointer(QNativePointer nativePointer)
nativePointer
- the QNativePointer of which object should be returned.
|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |