org.apache.james.imap.message.response

Class AbstractListingResponse

java.lang.Object

org.apache.james.imap.message.response.AbstractListingResponse

Direct Known Subclasses:

ListResponse, LSubResponse, XListResponse

public abstract class AbstractListingResponse
extends Object

LIST and LSUB return identical data.

Constructor Summary

Constructors

Constructor and Description
AbstractListingResponse(boolean noInferiors, boolean noSelect, boolean marked, boolean unmarked, boolean hasChildren, boolean hasNoChildren, String name, char hierarchyDelimiter, MailboxType type)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
char	getHierarchyDelimiter() Gets hierarchy delimiter.
String	getName() Gets the listed name.
MailboxType	getType() returns type of the mailbox
boolean	hasChildren() Is the HasChildren name attribute set?
int	hashCode()
boolean	hasNoChildren() Is the HasNoChildren name attribute set?
boolean	isMarked() Is Marked name attribute set?
boolean	isNameAttributed() Are any name attributes set?
boolean	isNoInferiors() Is Noinferiors name attribute set?
boolean	isNoSelect() Is Noselect name attribute set?
boolean	isUnmarked() Is Unmarked name attribute set?
String	toString() Renders object as a string suitable for logging.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractListingResponse

public AbstractListingResponse(boolean noInferiors,
                       boolean noSelect,
                       boolean marked,
                       boolean unmarked,
                       boolean hasChildren,
                       boolean hasNoChildren,
                       String name,
                       char hierarchyDelimiter,
                       MailboxType type)

Method Detail

getHierarchyDelimiter

public final char getHierarchyDelimiter()

Gets hierarchy delimiter.

Returns:

hierarchy delimiter, or null if no hierarchy exists

isMarked

public final boolean isMarked()

Is Marked name attribute set?

Returns:

true if Marked, false otherwise

getName

public final String getName()

Gets the listed name.

Returns:

name of the listed mailbox, not null

isNoInferiors

public final boolean isNoInferiors()

Is Noinferiors name attribute set?

Returns:

true if Noinferiors, false otherwise

isNoSelect

public final boolean isNoSelect()

Is Noselect name attribute set?

Returns:

true if Noselect, false otherwise

isUnmarked

public final boolean isUnmarked()

Is Unmarked name attribute set?

Returns:

true if Unmarked, false otherwise

hasNoChildren

public boolean hasNoChildren()

Is the HasNoChildren name attribute set?

Returns:

true if HasNoChildren, false otherwise

hasChildren

public boolean hasChildren()

Is the HasChildren name attribute set?

Returns:

true if HasChildren, false otherwise

getType

public MailboxType getType()

returns type of the mailbox

Returns:

mailbox type

isNameAttributed

public final boolean isNameAttributed()

Are any name attributes set?

Returns:

true if isNoInferiors(), isNoSelect(), isMarked() or isUnmarked()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Renders object as a string suitable for logging.

Overrides:

toString in class Object

Returns:

a String representation of this object.