This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.mail.internet
class ContentDisposition

javax.mail.internet.ContentDisposition

Most common way to construct:

String s = …;

ContentDisposition cd = new ContentDisposition(s);

Based on 7 examples


public class ContentDisposition
extends Object

This class represents a MIME ContentDisposition value. It provides methods to parse a ContentDisposition string into individual components and to generate a MIME style ContentDisposition string.

See Also (auto-generated):

Session

Transport

Properties


Constructor Summary

          No-arg Constructor.

          Constructor that takes a ContentDisposition string.

          Constructor.
 
Method Summary
 String

          Return the disposition value.
 String

          Return the specified parameter value.
 ParameterList

          Return a ParameterList object that holds all the available parameters.
 void
setDisposition(String disposition)

          Set the disposition.
 void
setParameter(String name, String value)

          Set the specified parameter.
 void

          Set a new ParameterList.
 String

          Retrieve a RFC2045 style string representation of this ContentDisposition.
 

Constructor Detail

ContentDisposition

public ContentDisposition()
No-arg Constructor.


ContentDisposition

public ContentDisposition(String s)
                   throws ParseException
Constructor that takes a ContentDisposition string. The String is parsed into its constituents: dispostion and parameters. A ParseException is thrown if the parse fails.

Parameters:
s - the ContentDisposition string.
Throws:
ParseException - if the parse fails.

ContentDisposition

public ContentDisposition(String disposition,
                          ParameterList list)
Constructor.

Parameters:
disposition - disposition
list - ParameterList
Method Detail

getDisposition

public String getDisposition()
Return the disposition value.

Returns:
the disposition

getParameter

public String getParameter(String name)
Return the specified parameter value. Returns null if this parameter is absent.

Parameters:
name
Returns:
parameter value

getParameterList

public ParameterList getParameterList()
Return a ParameterList object that holds all the available parameters. Returns null if no parameters are available.

Returns:
ParameterList

setDisposition

public void setDisposition(String disposition)
Set the disposition. Replaces the existing disposition.

Parameters:
disposition - the disposition

setParameter

public void setParameter(String name,
                         String value)
Set the specified parameter. If this parameter already exists, it is replaced by this new value.

Parameters:
name - parameter name
value - parameter value

setParameterList

public void setParameterList(ParameterList list)
Set a new ParameterList.

Parameters:
list - ParameterList

toString

public String toString()
Retrieve a RFC2045 style string representation of this ContentDisposition. Returns null if the conversion failed.

Overrides:
toString in class Object
Returns:
RFC2045 style string


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention. The official Sun™ documentation can be found here at http://java.sun.com/products/javamail/javadocs/index.html.