org.apache.james.imap.message.response

Class ImmutableStatusResponse

java.lang.Object

org.apache.james.imap.message.response.ImmutableStatusResponse

All Implemented Interfaces:

ImapMessage, ImapResponseMessage, StatusResponse

public class ImmutableStatusResponse
extends Object
implements StatusResponse

Immutable status response. Suitable for unpooled usage.

See Also:

StatusResponse

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.imap.api.message.response.StatusResponse

StatusResponse.ResponseCode, StatusResponse.Type

Constructor Summary

Constructors

Constructor and Description
ImmutableStatusResponse(StatusResponse.Type serverResponseType, String tag, ImapCommand command, HumanReadableText textKey, StatusResponse.ResponseCode responseCode)

Method Summary

Methods

Modifier and Type	Method and Description
ImapCommand	getCommand() Gets the command.
StatusResponse.ResponseCode	getResponseCode() Gets the response code.
StatusResponse.Type	getServerResponseType() Gets the server response type of this status message.
String	getTag() Gets the tag.
HumanReadableText	getTextKey() Gets the key to the human readable text to be displayed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableStatusResponse

public ImmutableStatusResponse(StatusResponse.Type serverResponseType,
                       String tag,
                       ImapCommand command,
                       HumanReadableText textKey,
                       StatusResponse.ResponseCode responseCode)

Method Detail

getResponseCode

public StatusResponse.ResponseCode getResponseCode()

Description copied from interface: StatusResponse

Gets the response code. Optional.

Specified by:

getResponseCode in interface StatusResponse

Returns:

ResponseCode, or null if there is no response code

See Also:

StatusResponse.getResponseCode()

getServerResponseType

public StatusResponse.Type getServerResponseType()

Description copied from interface: StatusResponse

Gets the server response type of this status message.

Specified by:

getServerResponseType in interface StatusResponse

Returns:

The type, either StatusResponse.Type.BAD, StatusResponse.Type.BYE, StatusResponse.Type.NO, StatusResponse.Type.OK or StatusResponse.Type.PREAUTH

See Also:

StatusResponse.getServerResponseType()

getTag

public String getTag()

Description copied from interface: StatusResponse

Gets the tag.

Specified by:

getTag in interface StatusResponse

Returns:

if tagged response, the tag. Otherwise null.

See Also:

StatusResponse.getTag()

getTextKey

public HumanReadableText getTextKey()

Description copied from interface: StatusResponse

Gets the key to the human readable text to be displayed. Required.

Specified by:

getTextKey in interface StatusResponse

Returns:

key for the text message to be displayed, not null

See Also:

StatusResponse.getTextKey()

getCommand

public ImapCommand getCommand()

Description copied from interface: StatusResponse

Gets the command.

Specified by:

getCommand in interface StatusResponse

Returns:

if tagged response, the command. Otherwise null

See Also:

StatusResponse.getCommand()