org.cyclos.model.access.channels

Enum BuiltInChannel

java.lang.Object

java.lang.Enum<BuiltInChannel>

org.cyclos.model.access.channels.BuiltInChannel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BuiltInChannel>

public enum BuiltInChannel
extends java.lang.Enum<BuiltInChannel>

Built-in channels in Cyclos

Author:

jefferson, ameyer

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAIN
MOBILE
POS
SMS
WEB_SERVICES

Method Summary

Modifier and Type	Method and Description
static BuiltInChannel	getByInternalName(java.lang.String internalName) Returns the channel with the given internal name, or null if not found (or not a built-in channel)
java.lang.String	getDisplayName()
java.lang.String	getInternalName() Returns the channel internal name
static BuiltInChannel	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BuiltInChannel[]	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

Enum Constant Detail

MAIN

public static final BuiltInChannel MAIN

WEB_SERVICES

public static final BuiltInChannel WEB_SERVICES

SMS

public static final BuiltInChannel SMS

POS

public static final BuiltInChannel POS

MOBILE

public static final BuiltInChannel MOBILE

Method Detail

values

public static BuiltInChannel[] 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 (BuiltInChannel c : BuiltInChannel.values())
    System.out.println(c);

Returns:

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

valueOf

public static BuiltInChannel valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getByInternalName

public static BuiltInChannel getByInternalName(java.lang.String internalName)

Returns the channel with the given internal name, or null if not found (or not a built-in channel)

getDisplayName

public java.lang.String getDisplayName()

getInternalName

public java.lang.String getInternalName()

Returns the channel internal name