jain.protocol.ip.sip.header
Class ContentTypeHeader

java.lang.Object
  |
  +--jain.protocol.ip.sip.header.Header
        |
        +--jain.protocol.ip.sip.header.EntityHeader
              |
              +--jain.protocol.ip.sip.header.ContentTypeHeader

public final class ContentTypeHeader

extends EntityHeader

This class represents the Content-Type entity-header. A ContentTypeHeader indicates the media type of the entity-body sent to the recipient. There must be a ContentTypeHeader included in Messages which contain an entity-body. The media-type is represented in the same manner as AcceptHeader.

Version:

0.6

See Also:

AcceptHeader

Field Summary

static java.lang.String

token Token of ContentTypeHeader

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

ENTITY_HEADER, GENERAL_HEADER, REQUEST_HEADER, RESPONSE_HEADER

Constructor Summary

ContentTypeHeader(java.lang.String type, java.lang.String subType)
Creates a ContentTypeHeader based on given media type and sub-type

Method Summary

java.lang.Object	clone() Creates and returns a copy of ContentTypeHeader
boolean	equals(ContentTypeHeader contentTypeHeader) Indicates whether some other ContentTypeHeader is "equal to" this one
java.lang.String	getParameter(java.lang.String parameter) Gets the value of specified parameter in ContentTypeHeader
java.lang.String[]	getParameters() Gets an array of media-type's parameter names
java.lang.String	getSubType() Gets media sub-type of Header
java.lang.String	getType() Gets media type of Header
java.lang.String	getValue() Gets value of ContentTypeHeader
boolean	hasParameter(java.lang.String parameter) Gets boolean value to indicate if the ContentTypeHeader has specified parameter
boolean	hasParameters() Gets boolean value to indicate if the ContentTypeHeader has parameters
void	removeParameter(java.lang.String parameter) Removes specified parameter from ContentTypeHeader
void	removeParameters() Removes all parameters from ContentTypeHeader
void	setParameter(java.lang.String parameter, java.lang.String value) Sets value of parameter to value in ContentTypeHeader
void	setSubType(java.lang.String subType) Sets value of media subtype in ContentTypeHeader
void	setType(java.lang.String type) Sets value of media type in ContentTypeHeader

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 ContentTypeHeader

Constructor Detail

ContentTypeHeader

public ContentTypeHeader(java.lang.String type,
                         java.lang.String subType)
                  throws java.lang.IllegalArgumentException

Creates a ContentTypeHeader based on given media type and sub-type

Parameters:

type - media type

subType - media sub-type

Throws:

java.lang.IllegalArgumentException - if type or subtype are null or zero-length

Method Detail

getType

public java.lang.String getType()

Gets media type of Header

Returns:

media type of Header

getSubType

public java.lang.String getSubType()

Gets media sub-type of Header

Returns:

media sub-type of Header

setSubType

public void setSubType(java.lang.String subType)
                throws java.lang.IllegalArgumentException

Sets value of media subtype in ContentTypeHeader

Parameters:

subType - media sub-type

Throws:

java.lang.IllegalArgumentException - if sub-type is null or zero-length

setType

public void setType(java.lang.String type)
             throws java.lang.IllegalArgumentException

Sets value of media type in ContentTypeHeader

Parameters:

type - media type

Throws:

java.lang.IllegalArgumentException - if type is null or zero-length

getParameters

public java.lang.String[] getParameters()
                                 throws ParameterNotSetException

Gets an array of media-type's parameter names

Returns:

an array of media-type's parameter names

Throws:

ParameterNotSetException - if no parameters exist

getParameter

public java.lang.String getParameter(java.lang.String parameter)
                              throws ParameterNotSetException

Gets the value of specified parameter in ContentTypeHeader

Parameters:

parameter - parameter to retrieve

Returns:

the value of specified parameter in ContentTypeHeader

Throws:

ParameterNotSetException - if the extension does not exist

hasParameters

public boolean hasParameters()

Gets boolean value to indicate if the ContentTypeHeader has parameters

Returns:

boolean value to indicate if the ContentTypeHeader has parameters

hasParameter

public boolean hasParameter(java.lang.String parameter)

Gets boolean value to indicate if the ContentTypeHeader has specified parameter

Returns:

boolean value to indicate if the ContentTypeHeader has specified parameter

setParameter

public void setParameter(java.lang.String parameter,
                         java.lang.String value)
                  throws java.lang.IllegalArgumentException

Sets value of parameter to value in ContentTypeHeader

Parameters:

parameter - name of parameter

value - value of parameter

Throws:

java.lang.IllegalArgumentException - if parameter or value are null or zero-length

removeParameter

public void removeParameter(java.lang.String parameter)

Removes specified parameter from ContentTypeHeader

Parameters:

parameter - parameter to remove from ContentTypeHeader

removeParameters

public void removeParameters()

Removes all parameters from ContentTypeHeader

Parameters:

parameter - parameter to remove from ContentTypeHeader

getValue

public java.lang.String getValue()

Gets value of ContentTypeHeader

Overrides:

getValue in class Header

Returns:

value of ContentTypeHeader

clone

public java.lang.Object clone()

Creates and returns a copy of ContentTypeHeader

Overrides:

clone in class Header

equals

public boolean equals(ContentTypeHeader contentTypeHeader)

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

Parameters:

contentTypeHeader - the ContentTypeHeader with which to compare