Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mrbook >> mrpostman >> another >> [ summary overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.mrbook.mrpostman.another.summary
Class MailDropSummary  

java.lang.Object
  org.mrbook.mrpostman.another.summary.MailDropSummary

---

public class MailDropSummary

extends java.lang.Object

Summary class. This will store the mail drop summary info

---

Field Summary
static java.lang.String	CVSID
private  java.lang.String	errors           Any general error messages that may have occured (not related to a particular message) Multiple messages are separated by a newline.
private  int	numberOfMessages           The total number of messages in the inbox
private  int	numDeleted           The total number of DELE commands issued
private  int	numErrors           The total number of errors encountered.
private  int	numRead           The total number of RETR commands issued
private  int	numTopped           The total number of TOP commands issued
private  java.util.LinkedList	summaryItems           Represents the list of message SummaryItems
private  java.lang.String	username           The username of the maildrop

 

Constructor Summary

MailDropSummary()

 

Method Summary
void	addGeneralError(java.lang.String newError)           Add an error to our list of non-message related errors.
void	deleFailure(int messageNumber, java.lang.String errorMsg)           Record that the issued DELE command on the specified number resulted in an error.
void	deleSuccess(int messageNumber)           Record that the issued DELE command on the specified number was a success.
protected  java.lang.String	getSessionSpecificSummaryInfo()           Override this in subclasses to include any supplementary summary info specific to subclass in the summary string.
SummaryItem	getSummaryItemForMsg(int msgNumber)           Return the SummaryItem info for a particular message number.
void	retrFailure(int messageNumber, java.lang.String errorMsg)           Record that the issued RETR command on the specified number resulted in an error.
void	retrSuccess(int messageNumber)           Record that the issued RETR command on the specified number was a success.
void	setMsgHeader(int msgNumber, HeaderInfo header)           Set the specified message's header info.
void	setNumberOfMessages(int numMessages)
void	setUsername(java.lang.String username)
void	topFailure(int messageNumber, java.lang.String errorMsg)           Record that the issued TOP command on the specified number resulted in an error.
void	topSuccess(int messageNumber)           Record that the issued TOP command on the specified number was a success.
java.lang.String	toString()           Create a String representation of all the summary information.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

CVSID

public static final java.lang.String CVSID

See Also:

Constant Field Values

---

summaryItems

private java.util.LinkedList summaryItems

Represents the list of message SummaryItems

---

numTopped

private int numTopped

The total number of TOP commands issued

---

numRead

private int numRead

The total number of RETR commands issued

---

numDeleted

private int numDeleted

The total number of DELE commands issued

---

numErrors

private int numErrors

The total number of errors encountered.

---

numberOfMessages

private int numberOfMessages

The total number of messages in the inbox

---

username

private java.lang.String username

The username of the maildrop

---

errors

private java.lang.String errors

Any general error messages that may have occured (not related to a particular message) Multiple messages are separated by a newline.

Constructor Detail

MailDropSummary

public MailDropSummary()

Method Detail

setUsername

public void setUsername(java.lang.String username)

---

setNumberOfMessages

public void setNumberOfMessages(int numMessages)

---

retrSuccess

public void retrSuccess(int messageNumber)

Record that the issued RETR command on the specified number was a success.

---

retrFailure

public void retrFailure(int messageNumber,
                        java.lang.String errorMsg)

Record that the issued RETR command on the specified number resulted in an error.

---

topSuccess

public void topSuccess(int messageNumber)

Record that the issued TOP command on the specified number was a success.

---

topFailure

public void topFailure(int messageNumber,
                       java.lang.String errorMsg)

Record that the issued TOP command on the specified number resulted in an error.

---

deleSuccess

public void deleSuccess(int messageNumber)

Record that the issued DELE command on the specified number was a success.

---

deleFailure

public void deleFailure(int messageNumber,
                        java.lang.String errorMsg)

Record that the issued DELE command on the specified number resulted in an error.

---

toString

public java.lang.String toString()

Create a String representation of all the summary information.

---

getSessionSpecificSummaryInfo

protected java.lang.String getSessionSpecificSummaryInfo()

Override this in subclasses to include any supplementary summary info specific to subclass in the summary string.

---

getSummaryItemForMsg

public SummaryItem getSummaryItemForMsg(int msgNumber)

Return the SummaryItem info for a particular message number. Note: message number starts from 1

---

addGeneralError

public void addGeneralError(java.lang.String newError)

Add an error to our list of non-message related errors.

---

setMsgHeader

public void setMsgHeader(int msgNumber,
                         HeaderInfo header)

Set the specified message's header info.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mrbook >> mrpostman >> another >> [ summary overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---