io.pkts.packet.sip.header.impl

Class FromHeaderImpl

java.lang.Object

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

io.pkts.packet.sip.header.impl.ParametersImpl

io.pkts.packet.sip.header.impl.AddressParametersHeaderImpl

io.pkts.packet.sip.header.impl.FromHeaderImpl

All Implemented Interfaces:

AddressParametersHeader, FromHeader, HeaderAddress, Parameters, SipHeader, Cloneable

public class FromHeaderImpl
extends AddressParametersHeaderImpl
implements FromHeader

Author:

jonas@jonasborjesson.com

Nested Class Summary

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

FromHeader.Builder

Field Summary

Fields inherited from class io.pkts.packet.sip.header.impl.AddressParametersHeaderImpl

TAG

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

NAME

Constructor Summary

Constructors

Constructor and Description
FromHeaderImpl(Address address, Buffer params)

Method Summary

Modifier and Type	Method and Description
FromHeader	clone()
FromHeader	ensure() If this method actually gets called it means that we are the As most things in this library are done lazily, such as framing headers, you can make sure that a particular header has indeed been parsed to the more specific header type by calling this method.
Buffer	getTag() Get the tag parameter.

Methods inherited from class io.pkts.packet.sip.header.impl.AddressParametersHeaderImpl

equals, getAddress, getValue, transferValue

Methods inherited from class io.pkts.packet.sip.header.impl.ParametersImpl

getParameter, getParameter, setParameter, setParameter

Methods inherited from class io.pkts.packet.sip.header.impl.SipHeaderImpl

getBytes, getName, toString, verify

Methods inherited from class java.lang.Object

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

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

frame, generateTag, with, with

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

with

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

getAddress

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

getParameter, getParameter, setParameter, setParameter

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

getBytes, getName, getValue, verify

Constructor Detail

FromHeaderImpl

public FromHeaderImpl(Address address,
                      Buffer params)

Parameters:

name -

address -

params -

Method Detail

getTag

public Buffer getTag()
              throws SipParseException

Get the tag parameter.

Specified by:

getTag in interface FromHeader

Returns:

the tag or null if it hasn't been set.

Throws:

SipParseException - in case anything goes wrong while extracting tag.

clone

public FromHeader clone()

Specified by:

clone in interface FromHeader

Specified by:

clone in interface SipHeader

Overrides:

clone in class SipHeaderImpl

ensure

public FromHeader ensure()

Description copied from class: SipHeaderImpl

If this method actually gets called it means that we are the As most things in this library are done lazily, such as framing headers, you can make sure that a particular header has indeed been parsed to the more specific header type by calling this method. If the header has yet not been parsed fully, e.g., we may have extracted out a ContactHeader but it is still in its "raw" form and therefore represented as a SipHeader as opposed to an actual ContactHeader but by calling this method you will force the library to actually fully frame it.

Specified by:

ensure in interface SipHeader

Overrides:

ensure in class AddressParametersHeaderImpl

Returns: