|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectch.mimo.netty.handler.codec.icap.Encapsulated
public final class Encapsulated
This class parses, creates and provides the very important Encapsulated header to the Decoder and encapsulates the complexity of that header.
| Constructor Summary | |
|---|---|
Encapsulated()
|
|
Encapsulated(String headerValue)
Creates an instance based on the value given. |
|
| Method Summary | |
|---|---|
void |
addEntry(IcapMessageElementEnum name,
int position)
Sets an entry with it's corresponding position. |
IcapMessageElementEnum |
containsBodyEntry()
Gets whether the message contains a body entity. |
boolean |
containsEntry(IcapMessageElementEnum entity)
Gets whether a given entry exists in the header value. |
int |
encode(org.jboss.netty.buffer.ChannelBuffer buffer)
This method encodes an Encapsulated instance into an Icap Message. |
IcapMessageElementEnum |
getNextEntry()
Iterator method. |
void |
setEntryAsProcessed(IcapMessageElementEnum entryName)
reports that a given entry was processed and that the @see Encapsulated#getNextEntry() can now return the next entry in line or null if no more are present. |
String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public Encapsulated()
public Encapsulated(String headerValue)
headerValue - valid Encapsulated value.| Method Detail |
|---|
public boolean containsEntry(IcapMessageElementEnum entity)
entity - the entity such as REQHDR, RESHDR and so on.
public IcapMessageElementEnum containsBodyEntry()
IcapMessageElementEnum value.public IcapMessageElementEnum getNextEntry()
IcapMessageElementEnum or null if no more entries are available.method.public void setEntryAsProcessed(IcapMessageElementEnum entryName)
entryName - the entry that was procesed.
public void addEntry(IcapMessageElementEnum name,
int position)
name - the name of the Entry.position - the position of the entry within the icap message.
public int encode(org.jboss.netty.buffer.ChannelBuffer buffer)
throws UnsupportedEncodingException
Encapsulated instance into an Icap Message.
buffer - the Channelbuffer to encode into.
UnsupportedEncodingException - If a character cannot be encoded in ASCII.public String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||