Package csw.alarm.models

Class ShelveStatus

java.lang.Object

csw.alarm.models.ShelveStatus

All Implemented Interfaces:

enumeratum.EnumEntry, enumeratum.EnumEntry.Lowercase

Direct Known Subclasses:

ShelveStatus.Shelved$, ShelveStatus.Unshelved$

public abstract class ShelveStatus
extends 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()

Method Summary

Modifier and Type	Method	Description
static String	enumeratum$Enum$$existingEntriesString()
static scala.collection.immutable.Map<String,A>	extraNamesToValuesMap()
protected static scala.collection.immutable.IndexedSeq<A>	findValues()
static int	indexOf(A member)
static final scala.collection.immutable.Map<String,ShelveStatus>	lowerCaseNamesToValuesMap()
String	name()	The name of ShelveStatus e.g.
static scala.collection.immutable.Map<String,ShelveStatus>	namesToValuesMap()
static final scala.collection.immutable.Map<String,ShelveStatus>	upperCaseNameValuesToMap()
static scala.collection.immutable.IndexedSeq<ShelveStatus>	values()	Returns a collection of ShelveStatus e.g shelved or unshelved
static final scala.collection.immutable.Map<ShelveStatus,Object>	valuesToIndex()
static A	withName(String name)
static scala.util.Either<enumeratum.NoSuchMember<A>,A>	withNameEither(String name)
static A	withNameInsensitive(String name)
static scala.util.Either<enumeratum.NoSuchMember<A>,A>	withNameInsensitiveEither(String name)
static scala.Option<A>	withNameInsensitiveOption(String name)
static A	withNameLowercaseOnly(String name)
static scala.util.Either<enumeratum.NoSuchMember<A>,A>	withNameLowercaseOnlyEither(String name)
static scala.Option<A>	withNameLowercaseOnlyOption(String name)
static scala.Option<A>	withNameOption(String name)
static A	withNameUppercaseOnly(String name)
static scala.util.Either<enumeratum.NoSuchMember<A>,A>	withNameUppercaseOnlyEither(String name)
static scala.Option<A>	withNameUppercaseOnlyOption(String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface enumeratum.EnumEntry

enumeratum$EnumEntry$$stableEntryName

Methods inherited from interface enumeratum.EnumEntry.Lowercase

entryName, enumeratum$EnumEntry$Lowercase$$stableEntryName

Constructor Details

ShelveStatus

public ShelveStatus()

Method Details

namesToValuesMap

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

lowerCaseNamesToValuesMap

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

upperCaseNameValuesToMap

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

valuesToIndex

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

values

public static scala.collection.immutable.IndexedSeq<ShelveStatus> values()

Returns a collection of ShelveStatus e.g shelved or unshelved

Returns:

(undocumented)

extraNamesToValuesMap

public static scala.collection.immutable.Map<String,A> extraNamesToValuesMap()

withName

public static A withName(String name)

withNameOption

public static scala.Option<A> withNameOption(String name)

withNameEither

public static scala.util.Either<enumeratum.NoSuchMember<A>,A> withNameEither(String name)

withNameInsensitive

public static A withNameInsensitive(String name)

withNameUppercaseOnly

public static A withNameUppercaseOnly(String name)

withNameLowercaseOnly

public static A withNameLowercaseOnly(String name)

withNameInsensitiveOption

public static scala.Option<A> withNameInsensitiveOption(String name)

withNameUppercaseOnlyOption

public static scala.Option<A> withNameUppercaseOnlyOption(String name)

withNameLowercaseOnlyOption

public static scala.Option<A> withNameLowercaseOnlyOption(String name)

withNameInsensitiveEither

public static scala.util.Either<enumeratum.NoSuchMember<A>,A> withNameInsensitiveEither(String name)

withNameUppercaseOnlyEither

public static scala.util.Either<enumeratum.NoSuchMember<A>,A> withNameUppercaseOnlyEither(String name)

withNameLowercaseOnlyEither

public static scala.util.Either<enumeratum.NoSuchMember<A>,A> withNameLowercaseOnlyEither(String name)

indexOf

public static int indexOf(A member)

findValues

protected static scala.collection.immutable.IndexedSeq<A> findValues()

enumeratum$Enum$$existingEntriesString

public static String enumeratum$Enum$$existingEntriesString()

name

public String name()

The name of ShelveStatus e.g. for Shelved status, the name will be represented as shelved

Returns:

(undocumented)