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

COMPACT_NAME, NAME

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
FromHeaderImpl(Buffer value, Address address, Buffer params)

Method Summary

Modifier and Type	Method and Description
FromHeader	clone()
AddressParametersHeader.Builder<FromHeader>	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.
FromHeader	ensure() If this method actually gets called it means that we are the SipHeaderImpl itself and that we need to frame it further.
Buffer	getTag() Get the tag parameter.

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

equals, getAddress

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

getParameter, getParameter, getRawParams, setParameter, setParameter

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

getBytes, getName, getValue, toString, transferValue, 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

builder, frame, frame, generateTag, isFromHeader, toFromHeader, withAddress, withHost, withHost

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

isAddressParametersHeader, toAddressParametersHeader, 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

create, getBufferSize, getBytes, getName, getNameStr, getValue, is, is, isCallIdHeader, isContactHeader, isContentLengthHeader, isContentTypeHeader, isCSeqHeader, isExpiresHeader, isMaxForwardsHeader, isRecordRouteHeader, isRouteHeader, isSubjectHeader, isSystemHeader, isToHeader, isViaHeader, toCallIdHeader, toContactHeader, toContentLengthHeader, toContentTypeHeader, toCSeqHeader, toExpiresHeader, toMaxForwardsHeader, toRecordRouteHeader, toRouteHeader, toToHeader, toViaHeader, verify

Constructor Detail

FromHeaderImpl

public FromHeaderImpl(Buffer value,
                      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

copy

public AddressParametersHeader.Builder<FromHeader> 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 AddressParametersHeader

Specified by:

copy in interface FromHeader

Specified by:

copy in interface SipHeader

Overrides:

copy in class AddressParametersHeaderImpl

Returns:

ensure

public FromHeader ensure()

Description copied from class: SipHeaderImpl

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

Overrides:

ensure in class AddressParametersHeaderImpl

Returns: