jain.protocol.ip.sip.header
Class AcceptLanguageHeader

java.lang.Object
  |
  +--jain.protocol.ip.sip.header.Header
        |
        +--jain.protocol.ip.sip.header.GeneralHeader
              |
              +--jain.protocol.ip.sip.header.AcceptLanguageHeader

public final class AcceptLanguageHeader

extends GeneralHeader

This class represents the Accept-language request-header. AcceptLanguageHeader can be used in a RequestMessage to allow the client to indicate to the server in which language it would prefer to receive reason phrases, session descriptions or status responses carried as message bodies. The q-value is used in a similar manner to AcceptHeader to indicate degrees of preference.

Version:

0.6

See Also:

AcceptHeader

Field Summary

static java.lang.String

token Token of AcceptLanguageHeader

Fields inherited from class jain.protocol.ip.sip.header.Header

ENTITY_HEADER, GENERAL_HEADER, REQUEST_HEADER, RESPONSE_HEADER

Constructor Summary

AcceptLanguageHeader(java.lang.String languageRange)
Creates AcceptLanguageHeader based on given language-range

Method Summary

java.lang.Object	clone() Creates and returns a copy of AcceptLanguageHeader
boolean	equals(AcceptLanguageHeader acceptLanguageHeader) Indicates whether some other AcceptLanguageHeader is "equal to" this one
java.lang.String	getLanguageRange() Gets the language-range of AcceptLanguageHeader
float	getQValue() Gets the q-value of language-range in AcceptLanguageHeader
java.lang.String	getValue() Gets value of AcceptLanguageHeader
boolean	hasQValue() Indicates whether or not a q-value exists in AcceptLanguageHeader
void	removeQValue() Removes q-value from AcceptLanguageHeader
void	setLanguageRange(java.lang.String languageRange) Sets the language-range of AcceptLanguageHeader
void	setQValue(float qValue) Sets q-value of language-range in AcceptLanguageHeader Q-values allow the user to indicate the relative degree of preference for that language-range, using the qvalue scale from 0 to 1.

Methods inherited from class jain.protocol.ip.sip.header.Header

equals, getHeaderType, getToken, setValue, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

token

public static final java.lang.String token

Token of AcceptLanguageHeader

Constructor Detail

AcceptLanguageHeader

public AcceptLanguageHeader(java.lang.String languageRange)
                     throws java.lang.IllegalArgumentException

Creates AcceptLanguageHeader based on given language-range

Parameters:

languageRange - language-range

Throws:

java.lang.IllegalArgumentException - if languageRange is null

Method Detail

getLanguageRange

public java.lang.String getLanguageRange()

Gets the language-range of AcceptLanguageHeader

Returns:

language-range of AcceptLanguageHeader

getQValue

public float getQValue()
                throws ParameterNotSetException

Gets the q-value of language-range in AcceptLanguageHeader

Returns:

the q-value of language-range in AcceptLanguageHeader

Throws:

ParameterNotSetException - if q-value does not exist in AcceptLanguageHeader

removeQValue

public void removeQValue()

Removes q-value from AcceptLanguageHeader

hasQValue

public boolean hasQValue()

Indicates whether or not a q-value exists in AcceptLanguageHeader

Returns:

boolean to indicate whether or not a q-value exists in AcceptLanguageHeader

setLanguageRange

public void setLanguageRange(java.lang.String languageRange)
                      throws java.lang.IllegalArgumentException

Sets the language-range of AcceptLanguageHeader

Parameters:

languageRange - language-range of AcceptLanguageHeader

Throws:

java.lang.IllegalArgumentException - if languageRange is null

setQValue

public void setQValue(float qValue)
               throws java.lang.IllegalArgumentException

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

Parameters:

qValue - q-value betwwen 0 and 1

Throws:

java.lang.IllegalArgumentException - if qValue is not between 0 and 1

clone

public java.lang.Object clone()

Creates and returns a copy of AcceptLanguageHeader

Overrides:

clone in class Header

Returns:

copy of AcceptLanguageHeader

getValue

public java.lang.String getValue()

Gets value of AcceptLanguageHeader

Overrides:

getValue in class Header

Returns:

value of AcceptLanguageHeader

equals

public boolean equals(AcceptLanguageHeader acceptLanguageHeader)

Indicates whether some other AcceptLanguageHeader is "equal to" this one

Parameters:

acceptLanguageHeader - the AcceptLanguageHeader with which to compare