io.pkts.packet.sip.header

Interface Parameters

All Superinterfaces:

Cloneable, SipHeader

All Known Subinterfaces:

AddressParametersHeader, ContactHeader, ContentTypeHeader, FromHeader, RecordRouteHeader, RouteHeader, ToHeader, ViaHeader

All Known Implementing Classes:

AddressParametersHeaderImpl, ContactHeaderImpl, ContentTypeHeaderImpl, FromHeaderImpl, MediaTypeHeaderImpl, ParametersImpl, RecordRouteHeaderImpl, RouteHeaderImpl, ToHeaderImpl, ViaHeaderImpl

public interface Parameters
extends SipHeader

Author:

jonas@jonasborjesson.com

Method Summary

Modifier and Type	Method and Description
Buffer	getParameter(Buffer name) Get the value of the named parameter.
Buffer	getParameter(String name) Same as getParameter(Buffer).
void	setParameter(Buffer name, Buffer value) Sets the value of the specified parameter.
void	setParameter(Buffer name, java.util.function.Supplier<Buffer> value)

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

clone, ensure, frame, getBytes, getName, getValue, verify

Method Detail

getParameter

Buffer getParameter(Buffer name)
             throws SipParseException,
                    IllegalArgumentException

Get the value of the named parameter. If the named parameter is a so-called flag parameter, then the value returned will be an empty Buffer, which can be checked with Buffer.isEmpty() or Buffer.capacity(), which will return zero. As with any empty Buffer, if you do Buffer.toString() you will be getting an empty String back, which would be yet another way to check for a flag parameter.

Parameters:

name - the name of the parameter we are looking for.

Returns:

the value of the named parameter or null if there is no such parameter. If the named parameter is a flag parameter, then an empty buffer will be returned.

Throws:

SipParseException - in case anything goes wrong while extracting the parameter.

IllegalArgumentException - in case the name is null.

getParameter

Buffer getParameter(String name)
             throws SipParseException,
                    IllegalArgumentException

Same as getParameter(Buffer).

Parameters:

name -

Returns:

Throws:

SipParseException - in case anything goes wrong while extracting the parameter.

IllegalArgumentException - in case the name is null.

setParameter

void setParameter(Buffer name,
                  Buffer value)
           throws SipParseException,
                  IllegalArgumentException

Sets the value of the specified parameter. If there already is a parameter with the same name its value will be overridden. A value of null or a zero length buffer means that this parameter is a flag parameter

Parameters:

name - the name of the parameter

value - the value of the parameter or null if you just want to set a flag parameter

Throws:

SipParseException - in case anything goes wrong when setting the parameter.

IllegalArgumentException - in case the name is null or empty.

setParameter

void setParameter(Buffer name,
                  java.util.function.Supplier<Buffer> value)
           throws SipParseException,
                  IllegalArgumentException

Throws:

SipParseException

IllegalArgumentException