Package com.mindee.product.us.usmail

Class UsMailV3Document

java.lang.Object

com.mindee.parsing.common.Prediction

com.mindee.product.us.usmail.UsMailV3Document

public class UsMailV3Document
extends Prediction

US Mail API version 3.0 document data.

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanField	isReturnToSender	Whether the mailing is marked as return to sender.
protected List<UsMailV3RecipientAddress>	recipientAddresses	The addresses of the recipients.
protected List<StringField>	recipientNames	The names of the recipients.
protected UsMailV3SenderAddress	senderAddress	The address of the sender.
protected StringField	senderName	The name of the sender.

Constructor Summary

Constructors

Constructor	Description
UsMailV3Document()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BooleanField	getIsReturnToSender()	Whether the mailing is marked as return to sender.
List<UsMailV3RecipientAddress>	getRecipientAddresses()	The addresses of the recipients.
List<StringField>	getRecipientNames()	The names of the recipients.
UsMailV3SenderAddress	getSenderAddress()	The address of the sender.
StringField	getSenderName()	The name of the sender.
int	hashCode()
boolean	isEmpty()	Returns true if there are no predictions values.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

isReturnToSender

protected BooleanField isReturnToSender

Whether the mailing is marked as return to sender.

recipientAddresses

protected List<UsMailV3RecipientAddress> recipientAddresses

The addresses of the recipients.

recipientNames

protected List<StringField> recipientNames

The names of the recipients.

senderAddress

protected UsMailV3SenderAddress senderAddress

The address of the sender.

senderName

protected StringField senderName

The name of the sender.

Constructor Detail

UsMailV3Document

public UsMailV3Document()

Method Detail

isEmpty

public boolean isEmpty()

Description copied from class: Prediction

Returns true if there are no predictions values. Accessing prediction values when this is true may result in a NullPointerException

Specified by:

isEmpty in class Prediction

toString

public String toString()

Overrides:

toString in class Object

getIsReturnToSender

public BooleanField getIsReturnToSender()

Whether the mailing is marked as return to sender.

getRecipientAddresses

public List<UsMailV3RecipientAddress> getRecipientAddresses()

The addresses of the recipients.

getRecipientNames

public List<StringField> getRecipientNames()

The names of the recipients.

getSenderAddress

public UsMailV3SenderAddress getSenderAddress()

The address of the sender.

getSenderName

public StringField getSenderName()

The name of the sender.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object