io.pkts.packet.sip.header.impl

Class SipHeaderImpl

java.lang.Object

io.pkts.packet.sip.header.impl.SipHeaderImpl

All Implemented Interfaces:

SipHeader, Cloneable

Direct Known Subclasses:

CallIdHeaderImpl, ContentLengthHeaderImpl, CSeqHeaderImpl, ExpiresHeaderImpl, MaxForwardsHeaderImpl, ParametersImpl

public class SipHeaderImpl
extends Object
implements SipHeader

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested classes/interfaces inherited from interface io.pkts.packet.sip.header.SipHeader

SipHeader.Builder<H extends SipHeader>

Field Summary

Fields inherited from interface io.pkts.packet.sip.header.SipHeader

CANNOT_CAST_HEADER_OF_TYPE, UNABLE_TO_PARSE_OUT_THE_HEADER_NAME_DUE_TO_UNDERLYING_IO_EXCEPTION

Constructor Summary

Constructors

Constructor and Description
SipHeaderImpl(Buffer name, Buffer value)

Method Summary

Modifier and Type	Method and Description
SipHeader	clone()
SipHeader.Builder<? extends SipHeader>	copy() Everything within the pkts.io SIP module are immutable so if you actually want to change anything you have to create a copy, which will return a specific Builder for that header.
SipHeader	ensure() If this method actually gets called it means that we are the SipHeaderImpl itself and that we need to frame it further.
void	getBytes(Buffer dst)
Buffer	getName() Subclasses may override this one and are in fact encourage to do so Get the name of the header
Buffer	getValue() Get the value of the buffer
String	toString()
protected void	transferValue(Buffer dst) Transfer the bytes of the value into the destination.
void	verify()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.pkts.packet.sip.header.SipHeader

create, frame, frame, getBufferSize, getNameStr, is, is, isAddressParametersHeader, isCallIdHeader, isContactHeader, isContentLengthHeader, isContentTypeHeader, isCSeqHeader, isExpiresHeader, isFromHeader, isMaxForwardsHeader, isRecordRouteHeader, isRouteHeader, isSubjectHeader, isSystemHeader, isToHeader, isViaHeader, toAddressParametersHeader, toCallIdHeader, toContactHeader, toContentLengthHeader, toContentTypeHeader, toCSeqHeader, toExpiresHeader, toFromHeader, toMaxForwardsHeader, toRecordRouteHeader, toRouteHeader, toToHeader, toViaHeader

Constructor Detail

SipHeaderImpl

public SipHeaderImpl(Buffer name,
                     Buffer value)

Method Detail

copy

public SipHeader.Builder<? extends SipHeader> copy()

Description copied from interface: SipHeader

Everything within the pkts.io SIP module are immutable so if you actually want to change anything you have to create a copy, which will return a specific Builder for that header.

Specified by:

copy in interface SipHeader

Returns:

getName

public Buffer getName()

Subclasses may override this one and are in fact encourage to do so Get the name of the header

Specified by:

getName in interface SipHeader

Returns:

getValue

public Buffer getValue()

Get the value of the buffer

Specified by:

getValue in interface SipHeader

Returns:

toString

public String toString()

Overrides:

toString in class Object

verify

public void verify()
            throws SipParseException

Specified by:

verify in interface SipHeader

Throws:

SipParseException

ensure

public SipHeader ensure()

If this method actually gets called it means that we are the SipHeaderImpl itself and that we need to frame it further. Subclasses MUST override this method and simply return 'this'.

Specified by:

ensure in interface SipHeader

Returns:

getBytes

public void getBytes(Buffer dst)

Specified by:

getBytes in interface SipHeader

transferValue

protected void transferValue(Buffer dst)

Transfer the bytes of the value into the destination. Sub-classes should override this method.

Parameters:

dst -

clone

public SipHeader clone()

Specified by:

clone in interface SipHeader

Overrides:

clone in class Object