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.


com.sun.mail.iap
class Argument

com.sun.mail.iap.Argument

public class Argument
extends Object


Field Summary
protected Vector items
          
 
Constructor Summary

          Constructor
 
Method Summary
 void

          append the given Argument to this Argument.
 void
write(Protocol protocol)

          
 void

          Write out as parenthesised list.
 void

          Write out given string as an Atom.
 void

          Write out given ByteArrayOutputStream as a Literal.
 void
writeBytes(byte[] b)

          Write out given byte[] as a Literal.
 void

          Write out given data as a literal.
 void
writeNumber(int i)

          Write out number.
 void
writeNumber(long i)

          Write out number.
 void

          Write out given string as an ASTRING, depending on the type of the characters inside the string.
 void
writeString(String s, String charset)

          Convert the given string into bytes in the specified charset, and write the bytes out as an ASTRING
 

Field Detail

items

protected Vector items
Constructor Detail

Argument

public Argument()
Constructor

Method Detail

append

public void append(Argument arg)
append the given Argument to this Argument. All items from the source argument are copied into this destination argument.

Parameters:
arg

write

public void write(Protocol protocol)
           throws IOException,
                  ProtocolException
Parameters:
protocol
Throws:
IOException
ProtocolException

writeArgument

public void writeArgument(Argument c)
Write out as parenthesised list.

Parameters:
c

writeAtom

public void writeAtom(String s)
Write out given string as an Atom. Note that an Atom can contain only certain US-ASCII characters. No validation is done on the characters in the string.

Parameters:
s - String

writeBytes

public void writeBytes(ByteArrayOutputStream b)
Write out given ByteArrayOutputStream as a Literal.

Parameters:
b - ByteArrayOutputStream to be written out.

writeBytes

public void writeBytes(byte[] b)
Write out given byte[] as a Literal.

Parameters:
b - byte[] to write out

writeBytes

public void writeBytes(Literal b)
Write out given data as a literal.

Parameters:
b - Literal representing data to be written out.

writeNumber

public void writeNumber(int i)
Write out number.

Parameters:
i - number

writeNumber

public void writeNumber(long i)
Write out number.

Parameters:
i - number

writeString

public void writeString(String s)
Write out given string as an ASTRING, depending on the type of the characters inside the string. The string should contain only ASCII characters.

XXX: Hmm .. this should really be called writeASCII()

Parameters:
s - String to write out

writeString

public void writeString(String s,
                        String charset)
                 throws UnsupportedEncodingException
Convert the given string into bytes in the specified charset, and write the bytes out as an ASTRING

Parameters:
s
charset
Throws:
UnsupportedEncodingException


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.