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

gov.nist.javax.sip.header
Class AcceptLanguage

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.AcceptLanguage
All Implemented Interfaces:
HeaderExt, SIPHeaderNames, Serializable, Cloneable, AcceptLanguageHeader, Header, Parameters

public final class AcceptLanguage
extends ParametersHeader
implements AcceptLanguageHeader

Accept Language body.

Since:
1.1
 HTTP RFC 2616 Section 14.4
 Accept-Language = "Accept-Language" ":"
                         1#( language-range [ ";" "q" "=" qvalue ] )
       language-range  = ( ( 1*8ALPHA *( "-" 1*8ALPHA ) ) | "*" )

 
Version:
1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:25 $
Author:
M. Ranganathan
See Also:
AcceptLanguageList, Serialized Form

Field Summary
 
Fields inherited from interface javax.sip.header.AcceptLanguageHeader
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
AcceptLanguage()
          default constructor
 
Method Summary
 Locale getAcceptLanguage()
          Gets the language value of the AcceptLanguageHeader.
 String getLanguageRange()
          get the LanguageRange field
 float getQValue()
          get the QValue field.
 boolean hasQValue()
          Return true if the q value has been set.
 void removeQValue()
          Remove the q value.
 void setAcceptLanguage(Locale language)
          Sets the language parameter of this AcceptLanguageHeader.
 void setLanguageRange(String languageRange)
          Set the languageRange.
 void setQValue(float q)
          Sets q-value for media-range in AcceptLanguageHeader.
 
Methods inherited from class gov.nist.javax.sip.header.ParametersHeader
clone, 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
equals, 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
clone, equals, getName, hashCode, toString
 

Constructor Detail

AcceptLanguage

public AcceptLanguage()
default constructor

Method Detail

getLanguageRange

public String getLanguageRange()
get the LanguageRange field

Returns:
String

getQValue

public float getQValue()
get the QValue field. Return -1 if the parameter has not been set.

Specified by:
getQValue in interface AcceptLanguageHeader
Returns:
float

hasQValue

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

Returns:
boolean
Since:
1.0

removeQValue

public void removeQValue()
Remove the q value.

Since:
1.0

setLanguageRange

public void setLanguageRange(String languageRange)
Set the languageRange.

Parameters:
languageRange - is the language range to set.

setQValue

public void setQValue(float q)
               throws InvalidArgumentException
Sets q-value for media-range in AcceptLanguageHeader. Q-values allow the user to indicate the relative degree of preference for that media-range, using the qvalue scale from 0 to 1. If no q-value is present, the media-range should be treated as having a q-value of 1.

Specified by:
setQValue in interface AcceptLanguageHeader
Parameters:
q - The new float value of the q-value, a value of -1 resets the qValue.
Throws:
InvalidArgumentException - if the q parameter value is not -1 or between 0 and 1.

getAcceptLanguage

public Locale getAcceptLanguage()
Gets the language value of the AcceptLanguageHeader.

Specified by:
getAcceptLanguage in interface AcceptLanguageHeader
Returns:
the language Locale value of this AcceptLanguageHeader

setAcceptLanguage

public void setAcceptLanguage(Locale language)
Sets the language parameter of this AcceptLanguageHeader.

Specified by:
setAcceptLanguage in interface AcceptLanguageHeader
Parameters:
language - - the new Locale value of the language of AcceptLanguageHeader

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.