org.mjsip.sip.header

Class ParametricHeader

java.lang.Object

org.mjsip.sip.header.Header

org.mjsip.sip.header.ParametricHeader

Direct Known Subclasses:

AcceptEncodingHeader, AcceptHeader, AcceptLanguageHeader, AlertInfoHeader, EventHeader, MinSEHeader, NameAddressHeader, ReplacesHeader, SessionExpiresHeader, SubscriptionStateHeader, TokenParametricHeader, ViaHeader

public abstract class ParametricHeader
extends Header

Abstract ParametricHeader is the base class for all SIP Headers that include parameters

Field Summary

Fields inherited from class org.mjsip.sip.header.Header

name, value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParametricHeader(Header hd) Creates a new ParametricHeader.
protected	ParametricHeader(java.lang.String hname, java.lang.String hvalue) Creates a new ParametricHeader.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getParameter(java.lang.String pname) Gets the value of specified parameter.
java.util.Vector	getParameterNames() Gets a String Vector of parameter names.
java.lang.String	getParameters() Gets the string of all parameters.
boolean	hasParameter(java.lang.String pname) Whether there is the specified parameter
boolean	hasParameters() Whether there are any parameters
protected int	indexOfFirstSemi() Returns the index of the first semicolon before the first parameter.
void	removeParameter(java.lang.String pname) Removes specified parameter (if present)
void	removeParameters() Removes all parameters (if any)
void	setParameter(java.lang.String pname, java.lang.String pvalue) Sets the value of a specified parameter.

Methods inherited from class org.mjsip.sip.header.Header

clone, equals, getName, getValue, setValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ParametricHeader

protected ParametricHeader(java.lang.String hname,
                           java.lang.String hvalue)

Creates a new ParametricHeader.

ParametricHeader

protected ParametricHeader(Header hd)

Creates a new ParametricHeader.

Method Detail

indexOfFirstSemi

protected int indexOfFirstSemi()

Returns the index of the first semicolon before the first parameter.

Returns:

the index of the semicolon before the first parameter, or -1 if no parameter is present.

getParameters

public java.lang.String getParameters()

Gets the string of all parameters.

Returns:

Returns a string of all parameters or null if no parameter is present.

getParameter

public java.lang.String getParameter(java.lang.String pname)

Gets the value of specified parameter.

Returns:

Returns the value of the specified parameter or null if not present.

getParameterNames

public java.util.Vector getParameterNames()

Gets a String Vector of parameter names.

Returns:

Returns a String Vector of all parameter names or null if no parameter is present.

hasParameter

public boolean hasParameter(java.lang.String pname)

Whether there is the specified parameter

hasParameters

public boolean hasParameters()

Whether there are any parameters

removeParameters

public void removeParameters()

Removes all parameters (if any)

removeParameter

public void removeParameter(java.lang.String pname)

Removes specified parameter (if present)

setParameter

public void setParameter(java.lang.String pname,
                         java.lang.String pvalue)

Sets the value of a specified parameter. Zero-length String is returned in case of flag parameter (without value).