Package csw.alarm.models
Class AlarmType
- java.lang.Object
-
- csw.alarm.models.AlarmType
-
- All Implemented Interfaces:
enumeratum.EnumEntry
,enumeratum.EnumEntry.Lowercase
- Direct Known Subclasses:
AlarmType.Absolute$
,AlarmType.BitPattern$
,AlarmType.Calculated$
,AlarmType.Deviation$
,AlarmType.Discrepancy$
,AlarmType.Instrument$
,AlarmType.RateChange$
,AlarmType.RecipeDriven$
,AlarmType.Safety$
,AlarmType.Statistical$
,AlarmType.System$
public abstract class AlarmType extends java.lang.Object implements enumeratum.EnumEntry, enumeratum.EnumEntry.Lowercase
Represents the category of the Alarm. The type of an alarm is configured in the alarm config file which will be fixed for it's entire life span.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AlarmType.Absolute$
static class
AlarmType.BitPattern$
static class
AlarmType.Calculated$
static class
AlarmType.Deviation$
static class
AlarmType.Discrepancy$
static class
AlarmType.Instrument$
static class
AlarmType.RateChange$
static class
AlarmType.RecipeDriven$
static class
AlarmType.Safety$
static class
AlarmType.Statistical$
static class
AlarmType.System$
-
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 AlarmType()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.lang.String
enumeratum$Enum$$existingEntriesString()
protected static scala.collection.immutable.IndexedSeq<A>
findValues()
static int
indexOf(A member)
static scala.collection.immutable.Map<java.lang.String,AlarmType>
lowerCaseNamesToValuesMap()
java.lang.String
name()
The name of the AlarmType e.g.static scala.collection.immutable.Map<java.lang.String,AlarmType>
namesToValuesMap()
static scala.collection.immutable.Map<java.lang.String,AlarmType>
upperCaseNameValuesToMap()
static scala.collection.immutable.IndexedSeq<AlarmType>
values()
Returns a sequence of all alarm types e.g.static scala.collection.immutable.Map<AlarmType,java.lang.Object>
valuesToIndex()
static A
withName(java.lang.String name)
static scala.util.Either<enumeratum.NoSuchMember<A>,A>
withNameEither(java.lang.String name)
static A
withNameInsensitive(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 A
withNameLowercaseOnly(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 A
withNameUppercaseOnly(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)
-
-
-
Method Detail
-
namesToValuesMap
public static scala.collection.immutable.Map<java.lang.String,AlarmType> namesToValuesMap()
-
lowerCaseNamesToValuesMap
public static final scala.collection.immutable.Map<java.lang.String,AlarmType> lowerCaseNamesToValuesMap()
-
upperCaseNameValuesToMap
public static final scala.collection.immutable.Map<java.lang.String,AlarmType> upperCaseNameValuesToMap()
-
valuesToIndex
public static final scala.collection.immutable.Map<AlarmType,java.lang.Object> valuesToIndex()
-
values
public static scala.collection.immutable.IndexedSeq<AlarmType> values()
Returns a sequence of all alarm types e.g. Absolute, BitPattern, Calculated etc.- 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()
-
name
public java.lang.String name()
The name of the AlarmType e.g. forAbsolute
type of alarms, the name will be represented asabsolute
- Returns:
- (undocumented)
-
-