org.apache.james.imap.message.response

Class AbstactStatusResponseFactory

java.lang.Object

org.apache.james.imap.message.response.AbstactStatusResponseFactory

All Implemented Interfaces:

StatusResponseFactory

Direct Known Subclasses:

UnpooledStatusResponseFactory

public abstract class AbstactStatusResponseFactory
extends Object
implements StatusResponseFactory

Constructor Summary

Constructors

Constructor and Description
AbstactStatusResponseFactory()

Method Summary

Methods

Modifier and Type	Method and Description
StatusResponse	bye(HumanReadableText displayTextKey) Creates a BYE status response.
StatusResponse	bye(HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a BYE status response.
protected abstract StatusResponse	createResponse(StatusResponse.Type type, String tag, ImapCommand command, HumanReadableText displayTextKey, StatusResponse.ResponseCode code)
StatusResponse	preauth(HumanReadableText displayTextKey) Creates a PREAUTH status response.
StatusResponse	preauth(HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a PREAUTH status response.
StatusResponse	taggedBad(String tag, ImapCommand command, HumanReadableText displayTextKey) Creates a tagged BAD status response.
StatusResponse	taggedBad(String tag, ImapCommand command, HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a tagged BAD status response.
StatusResponse	taggedNo(String tag, ImapCommand command, HumanReadableText displayTextKey) Creates a tagged NO status response.
StatusResponse	taggedNo(String tag, ImapCommand command, HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a tagged NO status response.
StatusResponse	taggedOk(String tag, ImapCommand command, HumanReadableText displayTextKey) Creates a tagged OK status response.
StatusResponse	taggedOk(String tag, ImapCommand command, HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a tagged OK status response.
StatusResponse	untaggedBad(HumanReadableText displayTextKey) Creates a untagged BAD status response.
StatusResponse	untaggedBad(HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a untagged BAD status response.
StatusResponse	untaggedNo(HumanReadableText displayTextKey) Creates a untagged NO status response.
StatusResponse	untaggedNo(HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a untagged NO status response.
StatusResponse	untaggedOk(HumanReadableText displayTextKey) Creates a untagged OK status response.
StatusResponse	untaggedOk(HumanReadableText displayTextKey, StatusResponse.ResponseCode code) Creates a untagged OK status response.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstactStatusResponseFactory

public AbstactStatusResponseFactory()

Method Detail

createResponse

protected abstract StatusResponse createResponse(StatusResponse.Type type,
                            String tag,
                            ImapCommand command,
                            HumanReadableText displayTextKey,
                            StatusResponse.ResponseCode code)

bye

public StatusResponse bye(HumanReadableText displayTextKey,
                 StatusResponse.ResponseCode code)

Description copied from interface: StatusResponseFactory

Creates a BYE status response. These are always untagged.

Specified by:

bye in interface StatusResponseFactory

Parameters:

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

bye

public StatusResponse bye(HumanReadableText displayTextKey)

Description copied from interface: StatusResponseFactory

Creates a BYE status response. These are always untagged.

Specified by:

bye in interface StatusResponseFactory

Parameters:

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

preauth

public StatusResponse preauth(HumanReadableText displayTextKey,
                     StatusResponse.ResponseCode code)

Description copied from interface: StatusResponseFactory

Creates a PREAUTH status response. These are always untagged.

Specified by:

preauth in interface StatusResponseFactory

Parameters:

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

preauth

public StatusResponse preauth(HumanReadableText displayTextKey)

Description copied from interface: StatusResponseFactory

Creates a PREAUTH status response. These are always untagged.

Specified by:

preauth in interface StatusResponseFactory

Parameters:

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

taggedBad

public StatusResponse taggedBad(String tag,
                       ImapCommand command,
                       HumanReadableText displayTextKey,
                       StatusResponse.ResponseCode code)

Description copied from interface: StatusResponseFactory

Creates a tagged BAD status response.

Specified by:

taggedBad in interface StatusResponseFactory

Parameters:

tag - CharSequence, not null

command - ImapCommand, not null

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

taggedBad

public StatusResponse taggedBad(String tag,
                       ImapCommand command,
                       HumanReadableText displayTextKey)

Description copied from interface: StatusResponseFactory

Creates a tagged BAD status response.

Specified by:

taggedBad in interface StatusResponseFactory

Parameters:

tag - CharSequence, not null

command - ImapCommand, not null

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

taggedNo

public StatusResponse taggedNo(String tag,
                      ImapCommand command,
                      HumanReadableText displayTextKey,
                      StatusResponse.ResponseCode code)

Description copied from interface: StatusResponseFactory

Creates a tagged NO status response.

Specified by:

taggedNo in interface StatusResponseFactory

Parameters:

tag - CharSequence, not null

command - ImapCommand, not null

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

taggedNo

public StatusResponse taggedNo(String tag,
                      ImapCommand command,
                      HumanReadableText displayTextKey)

Description copied from interface: StatusResponseFactory

Creates a tagged NO status response.

Specified by:

taggedNo in interface StatusResponseFactory

Parameters:

tag - CharSequence, not null

command - ImapCommand, not null

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

taggedOk

public StatusResponse taggedOk(String tag,
                      ImapCommand command,
                      HumanReadableText displayTextKey,
                      StatusResponse.ResponseCode code)

Description copied from interface: StatusResponseFactory

Creates a tagged OK status response.

Specified by:

taggedOk in interface StatusResponseFactory

Parameters:

tag - operation tag, not null

command - ImapCommand, not null

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

taggedOk

public StatusResponse taggedOk(String tag,
                      ImapCommand command,
                      HumanReadableText displayTextKey)

Description copied from interface: StatusResponseFactory

Creates a tagged OK status response.

Specified by:

taggedOk in interface StatusResponseFactory

Parameters:

tag - CharSequence, not null

command - ImapCommand, not null

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

untaggedBad

public StatusResponse untaggedBad(HumanReadableText displayTextKey,
                         StatusResponse.ResponseCode code)

Description copied from interface: StatusResponseFactory

Creates a untagged BAD status response.

Specified by:

untaggedBad in interface StatusResponseFactory

Parameters:

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

untaggedBad

public StatusResponse untaggedBad(HumanReadableText displayTextKey)

Description copied from interface: StatusResponseFactory

Creates a untagged BAD status response.

Specified by:

untaggedBad in interface StatusResponseFactory

Parameters:

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

untaggedNo

public StatusResponse untaggedNo(HumanReadableText displayTextKey,
                        StatusResponse.ResponseCode code)

Description copied from interface: StatusResponseFactory

Creates a untagged NO status response.

Specified by:

untaggedNo in interface StatusResponseFactory

Parameters:

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

untaggedNo

public StatusResponse untaggedNo(HumanReadableText displayTextKey)

Description copied from interface: StatusResponseFactory

Creates a untagged NO status response.

Specified by:

untaggedNo in interface StatusResponseFactory

Parameters:

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null

untaggedOk

public StatusResponse untaggedOk(HumanReadableText displayTextKey,
                        StatusResponse.ResponseCode code)

Description copied from interface: StatusResponseFactory

Creates a untagged OK status response.

Specified by:

untaggedOk in interface StatusResponseFactory

Parameters:

displayTextKey - key to the human readable code to be displayed

code - ResponseCode, not null

Returns:

StatusResponse, not null

untaggedOk

public StatusResponse untaggedOk(HumanReadableText displayTextKey)

Description copied from interface: StatusResponseFactory

Creates a untagged OK status response.

Specified by:

untaggedOk in interface StatusResponseFactory

Parameters:

displayTextKey - key to the human readable code to be displayed

Returns:

StatusResponse, not null