gov.nist.javax.sip.header

Class AcceptLanguage

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.header.SIPObject

gov.nist.javax.sip.header.SIPHeader

gov.nist.javax.sip.header.ParametersHeader

gov.nist.javax.sip.header.AcceptLanguage

All Implemented Interfaces:

HeaderExt, ParametersExt, 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.9 $ $Date: 2010-05-06 14:07:52 $

Author:

M. Ranganathan

See Also:

AcceptLanguageList, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	languageRange languageRange field

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

duplicates, parameters

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.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

Constructors

Constructor and Description
AcceptLanguage() default constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected StringBuilder	encodeBody(StringBuilder encoding) Encode the value of this header to a string.
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, equalParameters, getMultiParameter, getMultiParameterNames, getMultiParameters, getMultiParameterValue, getNameValue, getParameter, getParameter, getParameterAsBoolean, getParameterAsFloat, getParameterAsHexInt, getParameterAsInt, getParameterAsLong, getParameterAsURI, getParameterNames, getParameters, getParameterValue, hasMultiParameter, hasMultiParameters, hasParameter, hasParameters, removeMultiParameter, removeMultiParameters, removeParameter, removeParameters, setMultiParameter, setMultiParameter, setParameter, setParameter, setParameter, setParameter, 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

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

Methods inherited from class java.lang.Object

finalize, 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

Field Detail

languageRange

protected String languageRange

languageRange field

Constructor Detail

AcceptLanguage

public AcceptLanguage()

default constructor

Method Detail

encodeBody

protected StringBuilder encodeBody(StringBuilder encoding)

Encode the value of this header to a string.

Specified by:

encodeBody in class ParametersHeader

Returns:

encoded header as a string.

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