Package csw.alarm.models

Class ShelveStatus

  • All Implemented Interfaces:
    enumeratum.EnumEntry, enumeratum.EnumEntry.Lowercase
    Direct Known Subclasses:
    ShelveStatus.Shelved$, ShelveStatus.Unshelved$
    public abstract class ShelveStatus
extends java.lang.Object
implements enumeratum.EnumEntry, enumeratum.EnumEntry.Lowercase
    Represents whether the alarm is shelved or not. Alarms that are shelved will automatically be unshelved at a specific time (currently configured at 8 AM local time) if it is not unshelved explicitly. This time is configurable e.g csw-alarm.shelve-timeout = h:m:s a .

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ShelveStatus.Shelved$
      Represents the shelved status of an alarm.
      static class  ShelveStatus.Unshelved$
      Represents the normal(unshelved) status of an alarm.

      • 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
      ShelveStatus()  

    • Constructor Detail

      • ShelveStatus

        public ShelveStatus()

    • Method Detail

      • namesToValuesMap

        public static scala.collection.immutable.Map<java.lang.String,​ShelveStatus> namesToValuesMap()

      • lowerCaseNamesToValuesMap

        public static final scala.collection.immutable.Map<java.lang.String,​ShelveStatus> lowerCaseNamesToValuesMap()

      • upperCaseNameValuesToMap

        public static final scala.collection.immutable.Map<java.lang.String,​ShelveStatus> upperCaseNameValuesToMap()

      • valuesToIndex

        public static final scala.collection.immutable.Map<ShelveStatus,​java.lang.Object> valuesToIndex()

      • values

        public static scala.collection.immutable.IndexedSeq<ShelveStatus> values()
        Returns a collection of ShelveStatus e.g shelved or unshelved
        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 ShelveStatus e.g. for Shelved status, the name will be represented as shelved
        Returns:
        (undocumented)