PipeliningStatus

Inheritance: java.lang.Object

public class PipeliningStatus

Defines pipelining status for mail client.

Methods

Method Description
getSupportedByServer() Gets value that indicates if pipelining mode is supported by a server.
getClientMode() Gets or sets a value that defines how mail client supports the pipelining
setClientMode(int value) Gets or sets a value that defines how mail client supports the pipelining
getPipeliningEnabled() Gets a value that defines if pipelining mode is enabled.
to_PipeliningStatus(boolean mode) Converts boolean value to PipeliningStatus object
to_PipeliningStatus(int mode) Converts PipeliningMode value to PipeliningStatus object
to_Boolean(PipeliningStatus status) Converts PipeliningStatus object to boolean value
to_Boolean() Converts PipeliningStatus object to boolean value
to_PipeliningMode(PipeliningStatus status) Converts PipeliningStatus object
toString() Returns a string that represents the current object.

getSupportedByServer()

public final boolean getSupportedByServer()

Gets value that indicates if pipelining mode is supported by a server.

Returns: boolean

getClientMode()

public final int getClientMode()

Gets or sets a value that defines how mail client supports the pipelining

Returns: int

setClientMode(int value)

public final void setClientMode(int value)

Gets or sets a value that defines how mail client supports the pipelining

Parameters:

Parameter Type Description
value int

getPipeliningEnabled()

public final boolean getPipeliningEnabled()

Gets a value that defines if pipelining mode is enabled.

Returns: boolean

to_PipeliningStatus(boolean mode)

public static PipeliningStatus to_PipeliningStatus(boolean mode)

Converts boolean value to PipeliningStatus object

Parameters:

Parameter Type Description
mode boolean true if pipelining has to be used, otherwise false

Returns: PipeliningStatus - Returns PipeliningStatus object

to_PipeliningStatus(int mode)

public static PipeliningStatus to_PipeliningStatus(int mode)

Converts PipeliningMode value to PipeliningStatus object

Parameters:

Parameter Type Description
mode int PipeliningMode value for conversion

Returns: PipeliningStatus - Returns PipeliningStatus object

to_Boolean(PipeliningStatus status)

public static boolean to_Boolean(PipeliningStatus status)

Converts PipeliningStatus object to boolean value

Parameters:

Parameter Type Description
status PipeliningStatus PipeliningStatus object for conversion

Returns: boolean - Returns true if pipelining is used, otherwise returns false.

to_Boolean()

public boolean to_Boolean()

Converts PipeliningStatus object to boolean value

Returns: boolean - Returns true if pipelining is used, otherwise returns false.

to_PipeliningMode(PipeliningStatus status)

public static int to_PipeliningMode(PipeliningStatus status)

Converts PipeliningStatus object

Parameters:

Parameter Type Description
status PipeliningStatus A PipeliningStatus value

Returns: int - A PipeliningMode value

toString()

public String toString()

Returns a string that represents the current object.

Returns: java.lang.String - A string that represents the current object.