io.openems.edge.common.component

Enum ComponentManager.ChannelId

java.lang.Object

java.lang.Enum<ComponentManager.ChannelId>

io.openems.edge.common.component.ComponentManager.ChannelId

All Implemented Interfaces:

ChannelId, java.io.Serializable, java.lang.Comparable<ComponentManager.ChannelId>

Enclosing interface:

ComponentManager

public static enum ComponentManager.ChannelId
extends java.lang.Enum<ComponentManager.ChannelId>
implements ChannelId

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONFIG_NOT_ACTIVATED
DEFAULT_CONFIGURATION_FAILED
DUPLICATED_COMPONENT_ID
WAS_OUT_OF_MEMORY

Method Summary

Modifier and Type	Method and Description
Doc	doc() Gets the Channel Doc for this ChannelId.
static ComponentManager.ChannelId	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ComponentManager.ChannelId[]	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 io.openems.edge.common.channel.ChannelId

channelIdUpperToCamel, id, name

Enum Constant Detail

CONFIG_NOT_ACTIVATED

public static final ComponentManager.ChannelId CONFIG_NOT_ACTIVATED

DUPLICATED_COMPONENT_ID

public static final ComponentManager.ChannelId DUPLICATED_COMPONENT_ID

WAS_OUT_OF_MEMORY

public static final ComponentManager.ChannelId WAS_OUT_OF_MEMORY

DEFAULT_CONFIGURATION_FAILED

public static final ComponentManager.ChannelId DEFAULT_CONFIGURATION_FAILED

Method Detail

values

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

Returns:

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

valueOf

public static ComponentManager.ChannelId 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

doc

public Doc doc()

Description copied from interface: ChannelId

Gets the Channel Doc for this ChannelId.

Specified by:

doc in interface ChannelId

Returns:

the Channel-Doc