gov.nist.javax.sip.header

Class UserAgent

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.header.SIPObject

gov.nist.javax.sip.header.SIPHeader

gov.nist.javax.sip.header.UserAgent

All Implemented Interfaces:

HeaderExt, SIPHeaderNames, Serializable, Cloneable, Header, UserAgentHeader

public class UserAgent
extends SIPHeader
implements UserAgentHeader

the UserAgent SIPObject.

Version:

1.2 $Revision: 1.9 $ $Date: 2010-05-06 14:07:53 $

Author:

Olivier Deruelle

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List	productTokens Product tokens.

Fields inherited from class gov.nist.javax.sip.header.SIPHeader

headerName

Fields inherited from class gov.nist.core.GenericObject

AND, AT, COLON, COMMA, DOT, DOUBLE_QUOTE, EQUALS, GREATER_THAN, HT, immutableClasses, indentation, LESS_THAN, LPAREN, matchExpression, NEWLINE, PERCENT, POUND, QUESTION, QUOTE, RETURN, RPAREN, SEMICOLON, SLASH, SP, STAR, stringRepresentation

Fields inherited from interface javax.sip.header.UserAgentHeader

NAME

Fields inherited from interface gov.nist.javax.sip.header.SIPHeaderNames

ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ALERT_INFO, ALLOW, ALLOW_EVENTS, AUTHENTICATION_INFO, AUTHORIZATION, CALL_ID, CALL_INFO, CONTACT, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CSEQ, DATE, ERROR_INFO, EVENT, EXPIRES, FROM, IN_REPLY_TO, JOIN, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, MIN_SE, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REFERRED_BY, REPLACES, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SESSION_EXPIRES, SIP_ETAG, SIP_IF_MATCH, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE

Constructor Summary

Constructors

Constructor and Description
UserAgent() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addProductToken(String pt) set the productToken field
Object	clone() Clones this object.
StringBuilder	encodeBody(StringBuilder buffer) Encode only the body of this header.
ListIterator	getProduct() Returns the list value of the product parameter.
void	setProduct(List product) Sets the product value of the UserAgentHeader.

Methods inherited from class gov.nist.javax.sip.header.SIPHeader

encode, encode, getHeaderName, getHeaderValue, getName, getValue, hashCode, isHeaderList, setHeaderName, toString

Methods inherited from class gov.nist.javax.sip.header.SIPObject

dbgPrint, debugDump, debugDump, equals, match

Methods inherited from class gov.nist.core.GenericObject

dbgPrint, getClassFromName, getIndentation, getMatcher, isMySubclass, makeClone, merge, setMatcher, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint

Methods inherited from class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.sip.header.Header

equals, getName, hashCode, toString

Field Detail

productTokens

protected List productTokens

Product tokens.

Constructor Detail

UserAgent

public UserAgent()

Constructor.

Method Detail

addProductToken

public void addProductToken(String pt)

set the productToken field

Parameters:

pt - String to set

encodeBody

public StringBuilder encodeBody(StringBuilder buffer)

Encode only the body of this header.

Specified by:

encodeBody in class SIPHeader

Returns:

encoded value of the header.

getProduct

public ListIterator getProduct()

Returns the list value of the product parameter.

Specified by:

getProduct in interface UserAgentHeader

Returns:

the software of this UserAgentHeader

setProduct

public void setProduct(List product)
                throws ParseException

Sets the product value of the UserAgentHeader.

Specified by:

setProduct in interface UserAgentHeader

Parameters:

product - - a List specifying the product value

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the product value.

clone

public Object clone()

Description copied from class: GenericObject

Clones this object.

Specified by:

clone in interface Header

Overrides:

clone in class GenericObject

Returns:

a deep copy of Header