com.mirth.connect.userutil

Class AttachmentEntry

java.lang.Object

com.mirth.connect.userutil.AttachmentEntry

All Implemented Interfaces:

Serializable

public class AttachmentEntry
extends Object
implements Serializable

Used to store and retrieve details about message attachments such as the name, contents, and MIME type. When using a variable to specify attachments, such as in an SMTP Sender or Web Service Sender, the variable must reference a list of AttachmentEntry objects.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttachmentEntry() Instantiates a new AttachmentEntry with no name, content, or MIME type.
AttachmentEntry(AttachmentEntry attachment) Instantiates a new AttachmentEntry that copies the name, content, and MIME type from a given AttachmentEntry object.
AttachmentEntry(String name, String content, String mimeType) Instantiates a new AttachmentEntry with a name, content, and a MIME type.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
String	getContent() Returns the content of the attachment entry.
String	getMimeType() Returns the MIME type of the attachment entry.
String	getName() Returns the name of the attachment entry.
void	setContent(String content) Sets the content of the attachment entry.
void	setMimeType(String mimeType) Sets the MIME type of the attachment entry.
void	setName(String name) Sets the name of the attachment entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachmentEntry

public AttachmentEntry()

Instantiates a new AttachmentEntry with no name, content, or MIME type.

AttachmentEntry

public AttachmentEntry(AttachmentEntry attachment)

Instantiates a new AttachmentEntry that copies the name, content, and MIME type from a given AttachmentEntry object.

Parameters:

attachment - The AttachmentEntry object to copy.

AttachmentEntry

public AttachmentEntry(String name,
                       String content,
                       String mimeType)

Instantiates a new AttachmentEntry with a name, content, and a MIME type.

Parameters:

name - The name of the attachment entry.

content - The content to store for the attachment entry.

mimeType - The MIME type of the attachment entry.

Method Detail

getName

public String getName()

Returns the name of the attachment entry.

Returns:

The name of the attachment entry.

setName

public void setName(String name)

Sets the name of the attachment entry.

Parameters:

name - The name of the attachment entry.

getContent

public String getContent()

Returns the content of the attachment entry.

Returns:

The content of the attachment entry.

setContent

public void setContent(String content)

Sets the content of the attachment entry.

Parameters:

content - The content of the attachment entry.

getMimeType

public String getMimeType()

Returns the MIME type of the attachment entry.

Returns:

The MIME type of the attachment entry.

setMimeType

public void setMimeType(String mimeType)

Sets the MIME type of the attachment entry.

Parameters:

mimeType - The MIME type of the attachment entry.

equals

public boolean equals(Object obj)

Description copied from class: java.lang.Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap