ContentType (JWAT common 1.2.1 API)

java.lang.Object
- org.jwat.common.ContentType

```
public class ContentType
extends java.lang.Object
```
This class represents a content-type string parsed, validated and decomposed into its separate components. It's based on the rfc2616 text and accordingly fairly strict concerning whitespaces. Whitespace is only permissible after a ';' and before and after the whole content-type string. ContentType, MediaType and parameter names are all converted to lower case.

Author:

nicl

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`CC_CONTROL` Control character characteristic.
`protected static int`	`CC_SEPARATOR_WS` Separator character characteristic.
`protected static byte[]`	`charCharacteristicsTab` Table of separator and control characters.
`java.lang.String`	`contentType` Parsed Content-type.
`java.lang.String`	`mediaType` Parsed Media-type.
`java.util.Map<java.lang.String,java.lang.String>`	`parameters` Optional `Map` of parameters.
`protected static int`	`S_CONTENTTYPE` Parsing content-type state.
`protected static int`	`S_MEDIATYPE` Parsing media-type state.
`protected static int`	`S_MEDIATYPE_WHITESPACE` Lenient parsing of trailing whitespace after media-type state.
`protected static int`	`S_PARAM_EQ` Parsing after a '=' character state.
`protected static int`	`S_PARAM_NAME` Parsing the parameter name state.
`protected static int`	`S_PARAM_QUOTED_PAIR` Parsing a quoted pair character state.
`protected static int`	`S_PARAM_QUOTED_VALUE` Parsing a quote parameter value state.
`protected static int`	`S_PARAM_VALUE` Parsing a parameter value token state.
`protected static int`	`S_PARAM_VALUE_WHITESPACE` Lenient parsing of trailing whitespace after argument value state.
`protected static int`	`S_SEMICOLON` Parsing after a ';' character state.
`protected static int`	`S_START` Beginning state.
`protected static java.lang.String`	`separators` rfc2616 separator minus space and tab.

Constructor Summary

Constructors
Constructor and Description

ContentType()

Constructors
Constructor and Description
`ContentType()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getParameter(java.lang.String name)` Return parameter value associated with supplied parameter name.
`int`	`hashCode()`
`static boolean`	`isTokenCharacter(int c)` Check whether character is a valid token.
`static ContentType`	`parseContentType(java.lang.String contentTypeStr)` Tries to parse and validate the given content-type string.
`static boolean`	`quote(java.lang.String str)` Determines whether a string should be quoted by examining if the string contains tabs and/or spaces.
`void`	`setParameter(java.lang.String name, java.lang.String value)` Set a parameter with the given (name, value) pair.
`java.lang.String`	`toString()`
`java.lang.String`	`toStringShort()` Returns the content-type omitting any parameters present.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - S_START
```
protected static final int S_START
```
    Beginning state.
    
    See Also:
    
    Constant Field Values
  - S_CONTENTTYPE
```
protected static final int S_CONTENTTYPE
```
    Parsing content-type state.
    
    See Also:
    
    Constant Field Values
  - S_MEDIATYPE
```
protected static final int S_MEDIATYPE
```
    Parsing media-type state.
    
    See Also:
    
    Constant Field Values
  - S_MEDIATYPE_WHITESPACE
```
protected static final int S_MEDIATYPE_WHITESPACE
```
    Lenient parsing of trailing whitespace after media-type state.
    
    See Also:
    
    Constant Field Values
  - S_SEMICOLON
```
protected static final int S_SEMICOLON
```
    Parsing after a ';' character state.
    
    See Also:
    
    Constant Field Values
  - S_PARAM_NAME
```
protected static final int S_PARAM_NAME
```
    Parsing the parameter name state.
    
    See Also:
    
    Constant Field Values
  - S_PARAM_EQ
```
protected static final int S_PARAM_EQ
```
    Parsing after a '=' character state.
    
    See Also:
    
    Constant Field Values
  - S_PARAM_VALUE
```
protected static final int S_PARAM_VALUE
```
    Parsing a parameter value token state.
    
    See Also:
    
    Constant Field Values
  - S_PARAM_QUOTED_VALUE
```
protected static final int S_PARAM_QUOTED_VALUE
```
    Parsing a quote parameter value state.
    
    See Also:
    
    Constant Field Values
  - S_PARAM_QUOTED_PAIR
```
protected static final int S_PARAM_QUOTED_PAIR
```
    Parsing a quoted pair character state.
    
    See Also:
    
    Constant Field Values
  - S_PARAM_VALUE_WHITESPACE
```
protected static final int S_PARAM_VALUE_WHITESPACE
```
    Lenient parsing of trailing whitespace after argument value state.
    
    See Also:
    
    Constant Field Values
  - CC_CONTROL
```
protected static final int CC_CONTROL
```
    Control character characteristic.
    
    See Also:
    
    Constant Field Values
  - CC_SEPARATOR_WS
```
protected static final int CC_SEPARATOR_WS
```
    Separator character characteristic.
    
    See Also:
    
    Constant Field Values
  - contentType
```
public java.lang.String contentType
```
    Parsed Content-type.
  - mediaType
```
public java.lang.String mediaType
```
    Parsed Media-type.
  - parameters
```
public java.util.Map<java.lang.String,java.lang.String> parameters
```
    Optional Map of parameters.
  - separators
```
protected static final java.lang.String separators
```
    rfc2616 separator minus space and tab.
    
    See Also:
    
    Constant Field Values
  - charCharacteristicsTab
```
protected static final byte[] charCharacteristicsTab
```
    Table of separator and control characters.
- Constructor Detail
  - ContentType
```
public ContentType()
```
- Method Detail
  - isTokenCharacter
```
public static boolean isTokenCharacter(int c)
```
    Check whether character is a valid token.
    
    Parameters:
    
    c - character to check
    
    Returns:
    
    boolean indicating whether character is a valid token
  - parseContentType
```
public static ContentType parseContentType(java.lang.String contentTypeStr)
```
    Tries to parse and validate the given content-type string. Also tries to parse and validate any optional parameters present in the string.
    
    Parameters:
    
    contentTypeStr - content-type string
    
    Returns:
    
    a content-type object with all information in separate structures.
  - getParameter
```
public java.lang.String getParameter(java.lang.String name)
```
    Return parameter value associated with supplied parameter name.
    
    Parameters:
    
    name - parameter name
    
    Returns:
    
    parameter value or null
  - setParameter
```
public void setParameter(java.lang.String name,
                         java.lang.String value)
```
    Set a parameter with the given (name, value) pair.
    
    Parameters:
    
    name - parameter name
    
    value - parameter value
  - quote
```
public static boolean quote(java.lang.String str)
```
    Determines whether a string should be quoted by examining if the string contains tabs and/or spaces.
    
    Parameters:
    
    str - input string
    
    Returns:
    
    boolean indicating if the string should be quoted
  - toStringShort
```
public java.lang.String toStringShort()
```
    Returns the content-type omitting any parameters present.
    
    Returns:
    
    content-type without any parameters included
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class ContentType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

S_START

S_CONTENTTYPE

S_MEDIATYPE

S_MEDIATYPE_WHITESPACE

S_SEMICOLON

S_PARAM_NAME

S_PARAM_EQ

S_PARAM_VALUE

S_PARAM_QUOTED_VALUE

S_PARAM_QUOTED_PAIR

S_PARAM_VALUE_WHITESPACE

CC_CONTROL

CC_SEPARATOR_WS

contentType

mediaType

parameters

separators

charCharacteristicsTab

Constructor Detail

ContentType

Method Detail

isTokenCharacter

parseContentType

getParameter

setParameter

quote

toStringShort

toString

equals

hashCode