Package io.openems.common.channel
Enum Level
- java.lang.Object
-
- java.lang.Enum<Level>
-
- io.openems.common.channel.Level
-
- All Implemented Interfaces:
OptionsEnum
,java.io.Serializable
,java.lang.Comparable<Level>
public enum Level extends java.lang.Enum<Level> implements OptionsEnum
Severity/visibility Level.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description FAULT
"Fault" indicates, that there is at least one fault message available.INFO
"Info" indicates, that everything is OK, but there is at least one informative messages available.OK
"OK" indicates, that everything is OK and there are no messages.WARNING
"Warning" indicates, that there is at least one warning message available.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.util.Optional<Level>
fromJson(com.google.gson.JsonElement element)
Gets the Level from a JsonElement.static java.util.Optional<Level>
fromJson(com.google.gson.JsonElement element, java.lang.String memberName)
Gets the Level from a JsonObject.static java.util.Optional<Level>
fromValue(int value)
Gets the Level from an integer value.java.lang.String
getName()
Gets this enums String representation.OptionsEnum
getUndefined()
Gets the enum that is used for 'UNDEFINED' values.int
getValue()
Gets this enums int representation.boolean
isAtLeast(Level level)
Is this Level at least as high as the other Level.static Level
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static Level[]
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 interface io.openems.common.types.OptionsEnum
asCamelCase, isUndefined
-
-
-
-
Enum Constant Detail
-
OK
public static final Level OK
"OK" indicates, that everything is OK and there are no messages.
-
INFO
public static final Level INFO
"Info" indicates, that everything is OK, but there is at least one informative messages available.
-
WARNING
public static final Level WARNING
"Warning" indicates, that there is at least one warning message available.
-
FAULT
public static final Level FAULT
"Fault" indicates, that there is at least one fault message available.
-
-
Method Detail
-
values
public static Level[] 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 (Level c : Level.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Level 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 namejava.lang.NullPointerException
- if the argument is null
-
getValue
public int getValue()
Description copied from interface:OptionsEnum
Gets this enums int representation.- Specified by:
getValue
in interfaceOptionsEnum
- Returns:
- the int representation
-
getName
public java.lang.String getName()
Description copied from interface:OptionsEnum
Gets this enums String representation.- Specified by:
getName
in interfaceOptionsEnum
- Returns:
- the String representation
-
getUndefined
public OptionsEnum getUndefined()
Description copied from interface:OptionsEnum
Gets the enum that is used for 'UNDEFINED' values.- Specified by:
getUndefined
in interfaceOptionsEnum
- Returns:
- the UNDEFINED enum
-
isAtLeast
public boolean isAtLeast(Level level)
Is this Level at least as high as the other Level.- Parameters:
level
- the other level- Returns:
- true if it as at least as high
-
fromValue
public static java.util.Optional<Level> fromValue(int value)
Gets the Level from an integer value.- Parameters:
value
- the integer value- Returns:
- the Level
-
fromJson
public static java.util.Optional<Level> fromJson(com.google.gson.JsonElement element, java.lang.String memberName)
Gets the Level from a JsonObject.- Parameters:
element
- the JsonObjectmemberName
- the name of the member of the JsonObject- Returns:
- the Level
-
fromJson
public static java.util.Optional<Level> fromJson(com.google.gson.JsonElement element)
Gets the Level from a JsonElement.- Parameters:
element
- the JsonElement- Returns:
- the Level
-
-