NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

gov.nist.javax.sip.header
Class Accept

java.lang.Object
  extended by gov.nist.core.GenericObject
      extended by gov.nist.javax.sip.header.SIPObject
          extended by gov.nist.javax.sip.header.SIPHeader
              extended by gov.nist.javax.sip.header.ParametersHeader
                  extended by gov.nist.javax.sip.header.Accept
All Implemented Interfaces:
HeaderExt, SIPHeaderNames, Serializable, Cloneable, AcceptHeader, Header, MediaType, Parameters

public final class Accept
extends ParametersHeader
implements AcceptHeader

Accept header : The top level header is actually AcceptList which is a list of Accept headers.

Since:
1.1
Version:
1.2 $Revision: 1.9 $ $Date: 2009/07/17 18:57:24 $
Author:
M. Ranganathan
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface javax.sip.header.AcceptHeader
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
Accept()
          default constructor
 
Method Summary
 boolean allowsAllContentSubTypes()
          returns true if this header allows all ContentSubTypes, false otherwise.
 boolean allowsAllContentTypes()
          returns true if this header allows all ContentTypes, false otherwise.
 Object clone()
          Clones this object.
 String getContentSubType()
          get the ContentSubType fiels
 String getContentType()
          get the contentType field
 MediaRange getMediaRange()
          get the MediaRange field
 float getQValue()
          Get the q value.
 boolean hasQValue()
          Return true if the q value has been set.
 void removeQValue()
          Remove the q value.
 void setContentSubType(String subtype)
          set the ContentSubType field
 void setContentType(String type)
          set the ContentType field
 void setMediaRange(MediaRange m)
          Set the mediaRange member
 void setQValue(float qValue)
          Set the q value
 
Methods inherited from class gov.nist.javax.sip.header.ParametersHeader
getNameValue, getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, setParameter, setParameter, setParameters, setQuotedParameter
 
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
getClassFromName, getMatcher, isMySubclass, makeClone, merge, setMatcher
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.sip.header.Parameters
getParameter, getParameterNames, removeParameter, setParameter
 
Methods inherited from interface javax.sip.header.Header
equals, getName, hashCode, toString
 

Constructor Detail

Accept

public Accept()
default constructor

Method Detail

allowsAllContentTypes

public boolean allowsAllContentTypes()
returns true if this header allows all ContentTypes, false otherwise.

Specified by:
allowsAllContentTypes in interface AcceptHeader
Returns:
Boolean

allowsAllContentSubTypes

public boolean allowsAllContentSubTypes()
returns true if this header allows all ContentSubTypes, false otherwise.

Specified by:
allowsAllContentSubTypes in interface AcceptHeader
Returns:
boolean

getMediaRange

public MediaRange getMediaRange()
get the MediaRange field

Returns:
MediaRange

getContentType

public String getContentType()
get the contentType field

Specified by:
getContentType in interface MediaType
Returns:
String

getContentSubType

public String getContentSubType()
get the ContentSubType fiels

Specified by:
getContentSubType in interface MediaType
Returns:
String

getQValue

public float getQValue()
Get the q value.

Specified by:
getQValue in interface AcceptHeader
Returns:
float

hasQValue

public boolean hasQValue()
Return true if the q value has been set.

Returns:
boolean

removeQValue

public void removeQValue()
Remove the q value.


setContentSubType

public void setContentSubType(String subtype)
set the ContentSubType field

Specified by:
setContentSubType in interface MediaType
Parameters:
subtype - String to set

setContentType

public void setContentType(String type)
set the ContentType field

Specified by:
setContentType in interface MediaType
Parameters:
type - String to set

setQValue

public void setQValue(float qValue)
               throws InvalidArgumentException
Set the q value

Specified by:
setQValue in interface AcceptHeader
Parameters:
qValue - float to set
Throws:
IllegalArgumentException - if qValue is <0.0 or >1.0
InvalidArgumentException - if the q parameter value is not -1 or between 0 and 1.

setMediaRange

public void setMediaRange(MediaRange m)
Set the mediaRange member

Parameters:
m - MediaRange field

clone

public Object clone()
Description copied from class: gov.nist.core.GenericObject
Clones this object.

Specified by:
clone in interface Header
Overrides:
clone in class ParametersHeader
Returns:
a deep copy of Header

NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Submit a bug report or feature request.