JavaMail API 1.6.2 · com.sun.mail.iap.Response

Field Summary

Modifier and Type	Field and Description
private static String	ASTRING_CHAR_DELIM An ASTRING_CHAR is any CHAR delimited by: SPACE \| CTL \| '(' \| ')' \| '{' \| '%' \| '*' \| '"' \| '\' (CTL is handled in readDelimString.)
private static String	ATOM_CHAR_DELIM An ATOM is any CHAR delimited by: SPACE \| CTL \| '(' \| ')' \| '{' \| '%' \| '*' \| '"' \| '\' \| ']' (CTL is handled in readDelimString.)
public static final int	BAD
protected byte[]	buffer
public static final int	BYE
public static final int	CONTINUATION
protected Exception	ex
private static final int	increment
protected int	index
public static final int	NO
public static final int	OK
protected int	pindex
protected int	size
public static final int	SYNTHETIC
protected String	tag
public static final int	TAG_MASK
public static final int	TAGGED
protected int	type
public static final int	TYPE_MASK
public static final int	UNTAGGED
protected boolean	utf8

Constructor Summary

Access	Constructor and Description
public	Response(String s)
public	Response(String the response string s, boolean allow UTF-8 in response? supportsUtf8) Constructor for testing.
public	Response(Protocol the Protocol object p) Read a new Response from the given Protocol
public	Response(Response the Response to copy r) Copy constructor.

Method Summary

Modifier and Type	Method and Description
public static Response	Returns: the synthetic Response object byeResponse(Exception the exception ex) Return a Response object that looks like a BYE protocol response.
public Exception	Returns: the exception getException() Return the exception for a synthetic BYE response.
public String	Returns: the rest of the response getRest() Return the rest of the response as a string, usually used to return the arbitrary message text after a NO response.
public String	Returns: tag of this tagged statement getTag() Return the tag, if this is a tagged statement.
public int	getType()
public boolean	isBAD()
public boolean	isBYE()
public boolean	isContinuation()
public boolean	Returns: true if the character is found isNextNonSpace(char the character to look for c) Skip past any spaces.
public boolean	isNO()
public boolean	isOK()
public boolean	isSynthetic()
public boolean	isTagged()
public boolean	isUnTagged()
private void	parse()
private Object	parseString(boolean parseAtoms, boolean returnString) Generic parsing routine that can parse out a Quoted-String, Literal or Atom and return the parsed token as a String or a ByteArray.
public byte	peekByte()
public String	Returns: an Atom readAtom() Extract an ATOM, starting at the current position.
public String	Returns: a String readAtomString() Extract an ASTRING, starting at the current position and return as a String.
public String[]	readAtomStringList()
public byte	Returns: the next byte readByte() Return the next byte from this Statement.
public ByteArray	Returns: a ByteArray readByteArray() Extract a NSTRING, starting at the current position.
public ByteArrayInputStream	Returns: a ByteArrayInputStream readBytes() Extract a NSTRING, starting at the current position.
private String	readDelimString(String delim) Extract a string stopping at control characters or any character in delim.
public long	Returns: a long readLong() Extract a long number, starting at the current position.
public int	Returns: a number readNumber() Extract an integer, starting at the current position.
public String	Returns: the string readString(char the delimiter character delim) Read a string as an arbitrary sequence of characters, stopping at the delimiter Used to read part of a response code inside [].
public String	Returns: a String readString() Extract a NSTRING, starting at the current position.
public String[]	readStringList()
private String[]	readStringList(boolean atom)
public void	reset() Reset pointer to beginning of response.
public void	skip(int count)
public void	skipSpaces()
public void	skipToken() Skip to the next space, for use in error recovery while parsing.
public boolean	Returns: true if the server supports UTF-8 supportsUtf8() Does the server support UTF-8?
private String	toString(byte[] buffer, int start, int end)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

ASTRING_CHAR_DELIM	back to summary
private static String ASTRING_CHAR_DELIM An ASTRING_CHAR is any CHAR delimited by: SPACE \| CTL \| '(' \| ')' \| '{' \| '%' \| '*' \| '"' \| '\' (CTL is handled in readDelimString.)

ATOM_CHAR_DELIM	back to summary
private static String ATOM_CHAR_DELIM An ATOM is any CHAR delimited by: SPACE \| CTL \| '(' \| ')' \| '{' \| '%' \| '*' \| '"' \| '\' \| ']' (CTL is handled in readDelimString.)

BAD	back to summary
public static final int BAD

buffer	back to summary
protected byte[] buffer

BYE	back to summary
public static final int BYE

CONTINUATION	back to summary
public static final int CONTINUATION

ex	back to summary
protected Exception ex Since JavaMail 1.5.4

increment	back to summary
private static final int increment

index	back to summary
protected int index

NO	back to summary
public static final int NO

OK	back to summary
public static final int OK

pindex	back to summary
protected int pindex

size	back to summary
protected int size

SYNTHETIC	back to summary
public static final int SYNTHETIC

tag	back to summary
protected String tag

TAG_MASK	back to summary
public static final int TAG_MASK

TAGGED	back to summary
public static final int TAGGED

type	back to summary
protected int type

TYPE_MASK	back to summary
public static final int TYPE_MASK

UNTAGGED	back to summary
public static final int UNTAGGED

utf8	back to summary
protected boolean utf8

Constructor Detail

Response	back to summary
public Response(String s)

Response	back to summary
public Response(String s, boolean supportsUtf8) Constructor for testing. Parameters s:String the response string supportsUtf8:boolean allow UTF-8 in response? Since JavaMail 1.6.0

Response

back to summary

public Response(String s, boolean supportsUtf8)

Constructor for testing.

Parameters

s:String: the response string
supportsUtf8:boolean: allow UTF-8 in response?

Since

JavaMail 1.6.0

Response	back to summary
public Response(Protocol p) throws IOException, ProtocolException Read a new Response from the given Protocol Parameters p:Protocol the Protocol object Exceptions IOException: for I/O errors ProtocolException: for protocol failures

Response

back to summary

public Response(Protocol p) throws IOException, ProtocolException

Read a new Response from the given Protocol

Parameters

p:Protocol: the Protocol object

Exceptions

IOException:: for I/O errors
ProtocolException:: for protocol failures

Response	back to summary
public Response(Response r) Copy constructor. Parameters r:Response the Response to copy

Response

back to summary

public Response(Response r)

Copy constructor.

Parameters

r:Response: the Response to copy

Method Detail

byeResponse	back to summary
public static Response byeResponse(Exception ex) Return a Response object that looks like a BYE protocol response. Include the details of the exception in the response string. Parameters ex:Exception the exception Returns:Response the synthetic Response object

byeResponse

back to summary

public static Response byeResponse(Exception ex)

Return a Response object that looks like a BYE protocol response. Include the details of the exception in the response string.

Parameters

ex:Exception: the exception

Returns:Response

the synthetic Response object

getException	back to summary
public Exception getException() Return the exception for a synthetic BYE response. Returns:Exception the exception Since JavaMail 1.5.4

getException

back to summary

public Exception getException()

Return the exception for a synthetic BYE response.

Returns:Exception: the exception
Since: JavaMail 1.5.4

getRest	back to summary
public String getRest() Return the rest of the response as a string, usually used to return the arbitrary message text after a NO response. Returns:String the rest of the response

getRest

back to summary

public String getRest()

Return the rest of the response as a string, usually used to return the arbitrary message text after a NO response.

Returns:String: the rest of the response

getTag	back to summary
public String getTag() Return the tag, if this is a tagged statement. Returns:String tag of this tagged statement

getTag

back to summary

public String getTag()

Return the tag, if this is a tagged statement.

Returns:String: tag of this tagged statement

getType	back to summary
public int getType()

isBAD	back to summary
public boolean isBAD()

isBYE	back to summary
public boolean isBYE()

isContinuation	back to summary
public boolean isContinuation()

isNextNonSpace	back to summary
public boolean isNextNonSpace(char c) Skip past any spaces. If the next non-space character is c, consume it and return true. Otherwise stop at that point and return false. Parameters c:char the character to look for Returns:boolean true if the character is found

isNextNonSpace

back to summary

public boolean isNextNonSpace(char c)

Skip past any spaces. If the next non-space character is c, consume it and return true. Otherwise stop at that point and return false.

Parameters

c:char: the character to look for

Returns:boolean

true if the character is found

isNO	back to summary
public boolean isNO()

isOK	back to summary
public boolean isOK()

isSynthetic	back to summary
public boolean isSynthetic()

isTagged	back to summary
public boolean isTagged()

isUnTagged	back to summary
public boolean isUnTagged()

parse	back to summary
private void parse()

parseString	back to summary
private Object parseString(boolean parseAtoms, boolean returnString) Generic parsing routine that can parse out a Quoted-String, Literal or Atom and return the parsed token as a String or a ByteArray. Errors or NIL data will return null.

peekByte	back to summary
public byte peekByte()

readAtom	back to summary
public String readAtom() Extract an ATOM, starting at the current position. Updates the internal index to beyond the Atom. Returns:String an Atom

readAtom

back to summary

public String readAtom()

Extract an ATOM, starting at the current position. Updates the internal index to beyond the Atom.

Returns:String: an Atom

readAtomString	back to summary
public String readAtomString() Extract an ASTRING, starting at the current position and return as a String. An ASTRING can be a QuotedString, a Literal or an Atom (plus ']'). Any errors in parsing returns null ASTRING := QuotedString \| Literal \| 1*ASTRING_CHAR Returns:String a String

readAtomString

back to summary

public String readAtomString()

Extract an ASTRING, starting at the current position and return as a String. An ASTRING can be a QuotedString, a Literal or an Atom (plus ']'). Any errors in parsing returns null ASTRING := QuotedString | Literal | 1*ASTRING_CHAR

Returns:String: a String

readAtomStringList	back to summary
public String[] readAtomStringList()

readByte	back to summary
public byte readByte() Return the next byte from this Statement. Returns:byte the next byte

readByte

back to summary

public byte readByte()

Return the next byte from this Statement.

Returns:byte: the next byte

readByteArray	back to summary
public ByteArray readByteArray() Extract a NSTRING, starting at the current position. Return it as a ByteArray. The sequence 'NIL' is returned as null NSTRING := QuotedString \| Literal \| "NIL" Returns:ByteArray a ByteArray

readByteArray

back to summary

public ByteArray readByteArray()

Extract a NSTRING, starting at the current position. Return it as a ByteArray. The sequence 'NIL' is returned as null NSTRING := QuotedString | Literal | "NIL"

Returns:ByteArray: a ByteArray

readBytes

back to summary

public ByteArrayInputStream readBytes()

Extract a NSTRING, starting at the current position. Return it as a ByteArrayInputStream. The sequence 'NIL' is returned as null NSTRING := QuotedString | Literal | "NIL"

Returns:ByteArrayInputStream: a ByteArrayInputStream

readDelimString	back to summary
private String readDelimString(String delim) Extract a string stopping at control characters or any character in delim.

readLong

back to summary

public long readLong()

Extract a long number, starting at the current position. Updates the internal index to beyond the number. Returns -1 if a long number was not found.

Returns:long: a long

readNumber

back to summary

public int readNumber()

Extract an integer, starting at the current position. Updates the internal index to beyond the number. Returns -1 if a number was not found.

Returns:int: a number

readString

back to summary

public String readString(char delim)

Read a string as an arbitrary sequence of characters, stopping at the delimiter Used to read part of a response code inside [].

Parameters

delim:char: the delimiter character

Returns:String

the string

readString

back to summary

public String readString()

Extract a NSTRING, starting at the current position. Return it as a String. The sequence 'NIL' is returned as null NSTRING := QuotedString | Literal | "NIL"

Returns:String: a String

readStringList	back to summary
public String[] readStringList()

readStringList	back to summary
private String[] readStringList(boolean atom)

reset	back to summary
public void reset() Reset pointer to beginning of response.

skip	back to summary
public void skip(int count)

skipSpaces	back to summary
public void skipSpaces()

skipToken	back to summary
public void skipToken() Skip to the next space, for use in error recovery while parsing.

supportsUtf8

back to summary

public boolean supportsUtf8()

Does the server support UTF-8?

Returns:boolean: true if the server supports UTF-8
Since: JavaMail 1.6.0

toString	back to summary
private String toString(byte[] buffer, int start, int end)

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public Class Response

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail