org.eclipse.kura.channel

Enum ChannelType

java.lang.Object

java.lang.Enum<ChannelType>

org.eclipse.kura.channel.ChannelType

All Implemented Interfaces:

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

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

This provides the necessary constants to denote the type of the channel (whether the channel is for reading or writing or both)

Since:

1.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
READ The channel will be used for performing reading operation
READ_WRITE The channel will be used for performing both reading and writing operations
WRITE The channel will be used for performing writing operation

Method Summary

Modifier and Type	Method and Description
static ChannelType	getChannelType(java.lang.String channelTypeString) Converts channelTypeString, if possible, to the related ChannelType.
static ChannelType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ChannelType[]	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

READ

public static final ChannelType READ

The channel will be used for performing reading operation

READ_WRITE

public static final ChannelType READ_WRITE

The channel will be used for performing both reading and writing operations

WRITE

public static final ChannelType WRITE

The channel will be used for performing writing operation

Method Detail

values

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

Returns:

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

valueOf

public static ChannelType 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

getChannelType

public static ChannelType getChannelType(java.lang.String channelTypeString)

Converts channelTypeString, if possible, to the related ChannelType.

Parameters:

channelTypeString - String that we want to use to get the respective ChannelType.

Returns:

a ChannelType that corresponds to the String passed as argument.

Throws:

java.lang.IllegalArgumentException - if the passed string does not correspond to an existing ChannelType.