Package csw.location.api.models
Class ComponentType
- java.lang.Object
-
- csw.location.api.models.ComponentType
-
- All Implemented Interfaces:
enumeratum.EnumEntry
,enumeratum.EnumEntry.CapitalSnakecase
,enumeratum.EnumEntry.Lowercase
,enumeratum.EnumEntry.Snakecase
- Direct Known Subclasses:
ComponentType.Assembly$
,ComponentType.Container$
,ComponentType.HCD$
,ComponentType.Machine$
,ComponentType.SequenceComponent$
,ComponentType.Sequencer$
,ComponentType.Service$
public abstract class ComponentType extends java.lang.Object implements enumeratum.EnumEntry, enumeratum.EnumEntry.Snakecase
Represents a type of the Component. It should be serializable since it has to be transmittable over the network. The type will always be represented in lower case.param: messageManifest represents the class name of message that a component will understand
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ComponentType.Assembly$
Represents a component that controls one or more HCDs or assembliesstatic class
ComponentType.Container$
Represents a container for components e.g assemblies and HCDsstatic class
ComponentType.HCD$
Represents a component that controls a hardware devicestatic class
ComponentType.Machine$
Represents a Machinestatic class
ComponentType.SequenceComponent$
Represents a sequence component e.g ocs_1, iris_1static class
ComponentType.Sequencer$
Represents a component that controls one or more assemblies or sequencersstatic class
ComponentType.Service$
Represents a general purpose service component e.g.-
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 ComponentType(java.lang.String messageManifest)
-
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,ComponentType>
lowerCaseNamesToValuesMap()
java.lang.String
messageManifest()
java.lang.String
name()
The name of ComponentType e.g.static scala.collection.immutable.Map<java.lang.String,ComponentType>
namesToValuesMap()
static scala.collection.immutable.Map<java.lang.String,ComponentType>
upperCaseNameValuesToMap()
static scala.collection.immutable.IndexedSeq<ComponentType>
values()
Returns a sequence of all component typesstatic scala.collection.immutable.Map<ComponentType,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)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
-
-
Method Detail
-
namesToValuesMap
public static scala.collection.immutable.Map<java.lang.String,ComponentType> namesToValuesMap()
-
lowerCaseNamesToValuesMap
public static final scala.collection.immutable.Map<java.lang.String,ComponentType> lowerCaseNamesToValuesMap()
-
upperCaseNameValuesToMap
public static final scala.collection.immutable.Map<java.lang.String,ComponentType> upperCaseNameValuesToMap()
-
valuesToIndex
public static final scala.collection.immutable.Map<ComponentType,java.lang.Object> valuesToIndex()
-
values
public static scala.collection.immutable.IndexedSeq<ComponentType> values()
Returns a sequence of all component types- 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()
-
messageManifest
public java.lang.String messageManifest()
-
name
public java.lang.String name()
The name of ComponentType e.g. for HCD components, the name will be represented ashcd
.- Returns:
- (undocumented)
-
-