Package com.redwood.scheduler.api.model.enumeration

Enum MailConnectionProtocol

java.lang.Object

java.lang.Enum<MailConnectionProtocol>

com.redwood.scheduler.api.model.enumeration.MailConnectionProtocol

All Implemented Interfaces:

BaseSchedulerEnumeration<MailConnectionProtocol,Character>, SchedulerEnumeration<MailConnectionProtocol>, Serializable, Comparable<MailConnectionProtocol>

public enum MailConnectionProtocol
extends Enum<MailConnectionProtocol>
implements SchedulerEnumeration<MailConnectionProtocol>

The mail connection protocol (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
IMAP	imap protocol
IMAPS	secure imap protocol
MSGraph	Microsoft Graph
POP3	pop3 protocol
POP3S	secure pop3 protocol
SMTP	smtp protocol
SMTPS	secure smtp protocol

Field Summary

Fields

Modifier and Type	Field	Description
static char	IMAPCode	The char returned from IMAP.getCodeEx().
static char	IMAPSCode	The char returned from IMAPS.getCodeEx().
static char	MSGraphCode	The char returned from MSGraph.getCodeEx().
static char	POP3Code	The char returned from POP3.getCodeEx().
static char	POP3SCode	The char returned from POP3S.getCodeEx().
static char	SMTPCode	The char returned from SMTP.getCodeEx().
static char	SMTPSCode	The char returned from SMTPS.getCodeEx().

Method Summary

Modifier and Type	Method	Description
char	getCodeEx()	Get the code that is used to represent this enumeration in the database.
Character	getCodeExCharacter()	Get the code that is used to represent this enumeration in the database.
String	getCodeExString()	Get the code that is used to represent this enumeration in the database.
Character	getCodeExValue()	Return the code for the enumeration item as the database type of this enumeration.
String	getDescriptionKey()	Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.
String	getTranslationEN()	Get the English name of this enumeration.
String	getTranslationKey()	Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.
static MailConnectionProtocol	safeValueOf(String value)	Helper function to return the MailConnectionProtocol represented by value.
static MailConnectionProtocol	valueOf(char code)	Helper function to return the MailConnectionProtocol represented by code.
static MailConnectionProtocol	valueOf(Character code)	Helper function to return the MailConnectionProtocol represented by code.
static MailConnectionProtocol	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MailConnectionProtocol	valueOfCode(String code)	Helper function to return the MailConnectionProtocol represented by code.
static MailConnectionProtocol[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration

name, ordinal

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

IMAP

public static final MailConnectionProtocol IMAP

imap protocol

IMAPS

public static final MailConnectionProtocol IMAPS

secure imap protocol

POP3

public static final MailConnectionProtocol POP3

pop3 protocol

POP3S

public static final MailConnectionProtocol POP3S

secure pop3 protocol

SMTP

public static final MailConnectionProtocol SMTP

smtp protocol

SMTPS

public static final MailConnectionProtocol SMTPS

secure smtp protocol

MSGraph

public static final MailConnectionProtocol MSGraph

Microsoft Graph

Field Detail

IMAPCode

public static final char IMAPCode

The char returned from IMAP.getCodeEx().

See Also:

IMAP, Constant Field Values

IMAPSCode

public static final char IMAPSCode

The char returned from IMAPS.getCodeEx().

See Also:

IMAPS, Constant Field Values

POP3Code

public static final char POP3Code

The char returned from POP3.getCodeEx().

See Also:

POP3, Constant Field Values

POP3SCode

public static final char POP3SCode

The char returned from POP3S.getCodeEx().

See Also:

POP3S, Constant Field Values

SMTPCode

public static final char SMTPCode

The char returned from SMTP.getCodeEx().

See Also:

SMTP, Constant Field Values

SMTPSCode

public static final char SMTPSCode

The char returned from SMTPS.getCodeEx().

See Also:

SMTPS, Constant Field Values

MSGraphCode

public static final char MSGraphCode

The char returned from MSGraph.getCodeEx().

See Also:

MSGraph, Constant Field Values

Method Detail

values

public static MailConnectionProtocol[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MailConnectionProtocol c : MailConnectionProtocol.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MailConnectionProtocol valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

valueOfCode

public static MailConnectionProtocol valueOfCode(String code)

Helper function to return the MailConnectionProtocol represented by code. code must be a single character. If code is null, longer than one character, empty, or not a valid code then this method will return null.

Parameters:

code - A string with one character that is one of the codes for MailConnectionProtocol

Returns:

The MailConnectionProtocol corresponding to code, or null, if code is null, longer than one character, or not a valid code

safeValueOf

public static MailConnectionProtocol safeValueOf(String value)

Helper function to return the MailConnectionProtocol represented by value. If value is null, or not a valid MailConnectionProtocol enumeration then this method will return null.

The main difference between this method and valueOf(String), is that this method will return null when passed an invalid value, valueOf(String) will throw an IllegalArgumentException.

Parameters:

value - The string value that corresponds to the requested enumeration value

Returns:

The MailConnectionProtocol corresponding to value, or null, if value is null, or not a valid enumeration

See Also:

valueOf(String)

valueOf

public static MailConnectionProtocol valueOf(Character code)

Helper function to return the MailConnectionProtocol represented by code. If code is null, or not a valid MailConnectionProtocol code then this method will return null.

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

The MailConnectionProtocol corresponding to code, or null, if code is null, or not a valid code

valueOf

public static MailConnectionProtocol valueOf(char code)

Helper function to return the MailConnectionProtocol represented by code. If code is not a valid MailConnectionProtocol code then this method will return null.

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

The MailConnectionProtocol corresponding to code, or null, if code is not a valid code

getCodeEx

public char getCodeEx()

Description copied from interface: SchedulerEnumeration

Get the code that is used to represent this enumeration in the database.

Specified by:

getCodeEx in interface SchedulerEnumeration<MailConnectionProtocol>

Returns:

the database code for the enumeration

getCodeExValue

public Character getCodeExValue()

Description copied from interface: BaseSchedulerEnumeration

Return the code for the enumeration item as the database type of this enumeration.

Specified by:

getCodeExValue in interface BaseSchedulerEnumeration<MailConnectionProtocol,Character>

Returns:

the enumeration code

getCodeExCharacter

public Character getCodeExCharacter()

Description copied from interface: SchedulerEnumeration

Get the code that is used to represent this enumeration in the database.

Specified by:

getCodeExCharacter in interface SchedulerEnumeration<MailConnectionProtocol>

Returns:

the database code for the enumeration

getTranslationKey

public String getTranslationKey()

Description copied from interface: BaseSchedulerEnumeration

Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.

Specified by:

getTranslationKey in interface BaseSchedulerEnumeration<MailConnectionProtocol,Character>

Returns:

the key.

getTranslationEN

public String getTranslationEN()

Description copied from interface: BaseSchedulerEnumeration

Get the English name of this enumeration.

Specified by:

getTranslationEN in interface BaseSchedulerEnumeration<MailConnectionProtocol,Character>

Returns:

the English name of this enumeration.

getDescriptionKey

public String getDescriptionKey()

Description copied from interface: BaseSchedulerEnumeration

Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.

Specified by:

getDescriptionKey in interface BaseSchedulerEnumeration<MailConnectionProtocol,Character>

Returns:

the key that can be passed to SchedulerSession.translateField(String) to retrieve the translated description.

getCodeExString

public String getCodeExString()

Description copied from interface: SchedulerEnumeration

Get the code that is used to represent this enumeration in the database.

Specified by:

getCodeExString in interface SchedulerEnumeration<MailConnectionProtocol>

Returns:

the database code for the enumeration