io.pkts.packet.sip.header.impl

Class ParametersImpl

java.lang.Object

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

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

All Implemented Interfaces:

Parameters, SipHeader, Cloneable

Direct Known Subclasses:

AddressParametersHeaderImpl, MediaTypeHeaderImpl

public abstract class ParametersImpl
extends SipHeaderImpl
implements Parameters

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

Modifier	Constructor and Description
protected	ParametersImpl(Buffer name, Buffer value, Buffer params)

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 Parameters.getParameter(Buffer).
protected Buffer	getRawParams()
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 class io.pkts.packet.sip.header.impl.SipHeaderImpl

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

clone, copy, create, ensure, frame, frame, getBufferSize, getBytes, getName, getNameStr, getValue, 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, verify

Constructor Detail

ParametersImpl

protected ParametersImpl(Buffer name,
                         Buffer value,
                         Buffer params)

Parameters:

name -

params -

Method Detail

getParameter

public Buffer getParameter(Buffer name)
                    throws SipParseException

Description copied from interface: Parameters

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.

Specified by:

getParameter in interface Parameters

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.

getParameter

public Buffer getParameter(String name)
                    throws SipParseException

Description copied from interface: Parameters

Same as Parameters.getParameter(Buffer).

Specified by:

getParameter in interface Parameters

Returns:

Throws:

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

setParameter

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

Description copied from interface: Parameters

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

Specified by:

setParameter in interface Parameters

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

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

Specified by:

setParameter in interface Parameters

Throws:

SipParseException

IllegalArgumentException

getRawParams

protected Buffer getRawParams()