io.pkts.packet.sip.header

Interface AddressParametersHeader

All Superinterfaces:

Cloneable, HeaderAddress, Parameters, SipHeader

All Known Subinterfaces:

ContactHeader, FromHeader, RecordRouteHeader, RouteHeader, ToHeader

All Known Implementing Classes:

AddressParametersHeaderImpl, ContactHeaderImpl, FromHeaderImpl, RecordRouteHeaderImpl, RouteHeaderImpl, ToHeaderImpl

public interface AddressParametersHeader
extends SipHeader, HeaderAddress, Parameters

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AddressParametersHeader.Builder<T extends AddressParametersHeader>

Method Summary

Modifier and Type	Method and Description
static Object[]	frame(Buffer buffer) Frame the value as a AddressParametersHeaderImpl.
static <T> AddressParametersHeader.Builder<AddressParametersHeader>	with(Buffer headerName)

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

clone, ensure, getBytes, getName, getValue, verify

Method Detail

frame

static Object[] frame(Buffer buffer)
               throws SipParseException

Frame the value as a AddressParametersHeaderImpl. This method assumes that you have already parsed out the actual header name, e.g. "To: ". Also, this method assumes that a message framer (or similar) has framed the buffer that is being passed in to us to only contain this header and nothing else. Note, as with all the frame-methods on all headers/messages/whatever, they do not do any validation that the information is actually correct. This method will simply only try and validate just enough to get the framing done.

Specified by:

frame in interface SipHeader

Parameters:

value -

Returns:

an array where the first object is a Address object and the second is a Buffer with all the parameters.

Throws:

SipParseException - in case anything goes wrong while parsing.

with

static <T> AddressParametersHeader.Builder<AddressParametersHeader> with(Buffer headerName)
                                                                  throws SipParseException

Throws:

SipParseException