com.openexchange.mail

Class MailFields

java.lang.Object

com.openexchange.mail.MailFields

public final class MailFields
extends java.lang.Object

MailFields - Container for instances of MailField providing common set-specific methods.

Author:

Thorben Betten

Constructor Summary

Constructors

Constructor and Description
MailFields() Initializes an empty instance of MailFields
MailFields(boolean initValue) Initializes an instance of MailFields with specified flag.
MailFields(java.util.Collection<MailField> mailFields) Initializes a new instance of MailFields pre-filled with specified collection of MailField constants.
MailFields(MailField[] mailFields) Initializes a new instance of MailFields pre-filled with specified array of MailField constants.
MailFields(MailField mailField, MailField... mailFields) Initializes a new instance of MailFields pre-filled with specified array of MailField constants.
MailFields(MailFields mailFields) Copy constructor: Initializes a new MailFields from specified mail fields.

Method Summary

Methods

Modifier and Type	Method and Description
MailFields	add(MailField mailField) Adds specified MailField constant.
void	addAll(java.util.Collection<MailField> mailFields) Adds specified collection of MailField constants.
void	addAll(MailField[] mailFields) Adds specified MailField constants.
boolean	contains(MailField mailField) Checks if specified MailField constant is contained.
boolean	containsAll(MailFields mailFields) Checks if all of specified mail field constants is contained.
boolean	containsAny(MailFields mailFields) Checks if any of specified mail field constants is contained.
boolean	equals(java.lang.Object obj)
int	hashCode()
boolean	isEmpty() Checks if this instance contains no fields.
boolean	removeAll(MailFields otherFields) Removes from this instance all of its fields that are contained in the specified mail fields.
void	removeMailField(MailField mailField) Removes specified MailField constant.
void	removeMailFields(MailField[] mailFields) Removes specified MailField constants.
boolean	retainAll(MailFields otherFields) Retains only the fields in this instance that are contained in the specified mail fields.
int	size() Gets the size.
MailField[]	toArray() Returns a newly created array of MailField constants
java.util.Set<MailField>	toSet() Returns a newly created set of MailField constants.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MailFields

public MailFields()

Initializes an empty instance of MailFields

MailFields

public MailFields(boolean initValue)

Initializes an instance of MailFields with specified flag.

MailFields

public MailFields(MailField mailField,
          MailField... mailFields)

Initializes a new instance of MailFields pre-filled with specified array of MailField constants.

Parameters:

mailField - The mail field to add

mailFields - Further mail fields to add

MailFields

public MailFields(MailField[] mailFields)

Initializes a new instance of MailFields pre-filled with specified array of MailField constants.

Parameters:

mailFields - The mail fields to add

MailFields

public MailFields(java.util.Collection<MailField> mailFields)

Initializes a new instance of MailFields pre-filled with specified collection of MailField constants.

Parameters:

mailFields - The collection of mail fields to add

MailFields

public MailFields(MailFields mailFields)

Copy constructor: Initializes a new MailFields from specified mail fields.

Parameters:

mailFields - The mail fields

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

size

public int size()

Gets the size.

Returns:

The size

add

public MailFields add(MailField mailField)

Adds specified MailField constant.

Parameters:

mailField - The mail field to add

Returns:

This instance with mail field added

addAll

public void addAll(MailField[] mailFields)

Adds specified MailField constants.

Parameters:

mailFields - The mail fields to add

addAll

public void addAll(java.util.Collection<MailField> mailFields)

Adds specified collection of MailField constants.

Parameters:

mailFields - The collection of MailField constants to add

removeMailField

public void removeMailField(MailField mailField)

Removes specified MailField constant.

Parameters:

mailField - The mail field to remove

removeMailFields

public void removeMailFields(MailField[] mailFields)

Removes specified MailField constants.

Parameters:

mailFields - The mail fields to remove

contains

public boolean contains(MailField mailField)

Checks if specified MailField constant is contained.

Parameters:

mailField - The mail field to check

Returns:

true if specified MailField constant is contained; otherwise false.

containsAny

public boolean containsAny(MailFields mailFields)

Checks if any of specified mail field constants is contained.

Parameters:

mailFields - The mail fields to check

Returns:

true if any of specified mail field constants is contained; otherwise false.

containsAll

public boolean containsAll(MailFields mailFields)

Checks if all of specified mail field constants is contained.

Parameters:

mailFields - The mail fields to check

Returns:

true if all of specified mail field constants is contained; otherwise false.

removeAll

public boolean removeAll(MailFields otherFields)

Removes from this instance all of its fields that are contained in the specified mail fields.

Parameters:

otherFields - The mail fields which will be removed from this instance

Returns:

true if this instance changed as a result of the call; otherwise false

retainAll

public boolean retainAll(MailFields otherFields)

Retains only the fields in this instance that are contained in the specified mail fields.

Parameters:

otherFields - The mail fields which this instance will retain

Returns:

true if this instance changed as a result of the call; otherwise false

isEmpty

public boolean isEmpty()

Checks if this instance contains no fields.

Returns:

true if this instance contains no fields; otherwise false

toArray

public MailField[] toArray()

Returns a newly created array of MailField constants

Returns:

A newly created array of MailField constants

toSet

public java.util.Set<MailField> toSet()

Returns a newly created set of MailField constants.

Returns:

A newly created set of MailField constants

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object