Package csw.alarm.models
Class AlarmSeverity
- java.lang.Object
-
- csw.alarm.models.FullAlarmSeverity
-
- csw.alarm.models.AlarmSeverity
-
- All Implemented Interfaces:
enumeratum.EnumEntry,enumeratum.EnumEntry.Lowercase
- Direct Known Subclasses:
AlarmSeverity.Critical$,AlarmSeverity.Indeterminate$,AlarmSeverity.Major$,AlarmSeverity.Okay$,AlarmSeverity.Warning$
public abstract class AlarmSeverity extends FullAlarmSeverity
Represents the alarm severity set by the component developer e.g Okay, Warning, Major, Indeterminate, Critical. Disconnected is not a part of AlarmSeverity as it is never set by the component developer.param: level is fundamental in comparing severities
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAlarmSeverity.Critical$Represents the critical state of an alarm for e.g.static classAlarmSeverity.Indeterminate$Represents the indeterminate state of an alarm, for e.g.static classAlarmSeverity.Major$Represents the major state of an alarm for e.g the operator needs to respond to a major alarm within 30 to 60 minutes.static classAlarmSeverity.Okay$Represents the normal operation of the alarmstatic classAlarmSeverity.Warning$Represents the warning state of an alarm for e.g.-
Nested classes/interfaces inherited from class csw.alarm.models.FullAlarmSeverity
FullAlarmSeverity.Disconnected$
-
Nested classes/interfaces inherited from interface enumeratum.EnumEntry
enumeratum.EnumEntry.Camelcase, enumeratum.EnumEntry.CapitalDotcase, enumeratum.EnumEntry.CapitalHyphencase, enumeratum.EnumEntry.CapitalSnakecase, enumeratum.EnumEntry.CapitalWords, enumeratum.EnumEntry.Dotcase, enumeratum.EnumEntry.EnumEntryOps<A extends enumeratum.EnumEntry>, enumeratum.EnumEntry.EnumEntryOps$, enumeratum.EnumEntry.Hyphencase, enumeratum.EnumEntry.LowerCamelcase, enumeratum.EnumEntry.Lowercase, enumeratum.EnumEntry.Snakecase, enumeratum.EnumEntry.Uncapitalised, enumeratum.EnumEntry.Uppercase, enumeratum.EnumEntry.UpperDotcase, enumeratum.EnumEntry.UpperHyphencase, enumeratum.EnumEntry.UpperSnakecase, enumeratum.EnumEntry.UpperWords, enumeratum.EnumEntry.Words
-
-
Constructor Summary
Constructors Constructor Description AlarmSeverity(int level)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.lang.Stringenumeratum$Enum$$existingEntriesString()protected static scala.collection.immutable.IndexedSeq<A>findValues()static intindexOf(A member)intlevel()static scala.collection.immutable.Map<java.lang.String,AlarmSeverity>lowerCaseNamesToValuesMap()static scala.collection.immutable.Map<java.lang.String,AlarmSeverity>namesToValuesMap()static scala.collection.immutable.Map<java.lang.String,AlarmSeverity>upperCaseNameValuesToMap()static scala.collection.immutable.IndexedSeq<AlarmSeverity>values()Returns a sequence of all alarm severity (except Disconnected)static scala.collection.immutable.Map<AlarmSeverity,java.lang.Object>valuesToIndex()static AwithName(java.lang.String name)static scala.util.Either<enumeratum.NoSuchMember<A>,A>withNameEither(java.lang.String name)static AwithNameInsensitive(java.lang.String name)static scala.util.Either<enumeratum.NoSuchMember<A>,A>withNameInsensitiveEither(java.lang.String name)static scala.Option<A>withNameInsensitiveOption(java.lang.String name)static AwithNameLowercaseOnly(java.lang.String name)static scala.util.Either<enumeratum.NoSuchMember<A>,A>withNameLowercaseOnlyEither(java.lang.String name)static scala.Option<A>withNameLowercaseOnlyOption(java.lang.String name)static scala.Option<A>withNameOption(java.lang.String name)static AwithNameUppercaseOnly(java.lang.String name)static scala.util.Either<enumeratum.NoSuchMember<A>,A>withNameUppercaseOnlyEither(java.lang.String name)static scala.Option<A>withNameUppercaseOnlyOption(java.lang.String name)-
Methods inherited from class csw.alarm.models.FullAlarmSeverity
max, name
-
-
-
-
Method Detail
-
namesToValuesMap
public static scala.collection.immutable.Map<java.lang.String,AlarmSeverity> namesToValuesMap()
-
lowerCaseNamesToValuesMap
public static final scala.collection.immutable.Map<java.lang.String,AlarmSeverity> lowerCaseNamesToValuesMap()
-
upperCaseNameValuesToMap
public static final scala.collection.immutable.Map<java.lang.String,AlarmSeverity> upperCaseNameValuesToMap()
-
valuesToIndex
public static final scala.collection.immutable.Map<AlarmSeverity,java.lang.Object> valuesToIndex()
-
values
public static scala.collection.immutable.IndexedSeq<AlarmSeverity> values()
Returns a sequence of all alarm severity (except Disconnected)- Returns:
- (undocumented)
-
withName
public static A withName(java.lang.String name)
-
withNameOption
public static scala.Option<A> withNameOption(java.lang.String name)
-
withNameEither
public static scala.util.Either<enumeratum.NoSuchMember<A>,A> withNameEither(java.lang.String name)
-
withNameInsensitive
public static A withNameInsensitive(java.lang.String name)
-
withNameUppercaseOnly
public static A withNameUppercaseOnly(java.lang.String name)
-
withNameLowercaseOnly
public static A withNameLowercaseOnly(java.lang.String name)
-
withNameInsensitiveOption
public static scala.Option<A> withNameInsensitiveOption(java.lang.String name)
-
withNameUppercaseOnlyOption
public static scala.Option<A> withNameUppercaseOnlyOption(java.lang.String name)
-
withNameLowercaseOnlyOption
public static scala.Option<A> withNameLowercaseOnlyOption(java.lang.String name)
-
withNameInsensitiveEither
public static scala.util.Either<enumeratum.NoSuchMember<A>,A> withNameInsensitiveEither(java.lang.String name)
-
withNameUppercaseOnlyEither
public static scala.util.Either<enumeratum.NoSuchMember<A>,A> withNameUppercaseOnlyEither(java.lang.String name)
-
withNameLowercaseOnlyEither
public static scala.util.Either<enumeratum.NoSuchMember<A>,A> withNameLowercaseOnlyEither(java.lang.String name)
-
indexOf
public static int indexOf(A member)
-
findValues
protected static scala.collection.immutable.IndexedSeq<A> findValues()
-
enumeratum$Enum$$existingEntriesString
public static java.lang.String enumeratum$Enum$$existingEntriesString()
-
level
public int level()
- Overrides:
levelin classFullAlarmSeverity
-
-