Package csw.location.api.models

Class ComponentType

java.lang.Object

csw.location.api.models.ComponentType

All Implemented Interfaces:

enumeratum.EnumEntry

Direct Known Subclasses:

ComponentType.Assembly$, ComponentType.Container$, ComponentType.HCD$, ComponentType.Machine$, ComponentType.SequenceComponent$, ComponentType.Sequencer$, ComponentType.Service$

public abstract class ComponentType
extends Object
implements enumeratum.EnumEntry

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 assemblies
static class	ComponentType.Container$	Represents a container for components e.g assemblies and HCDs
static class	ComponentType.HCD$	Represents a component that controls a hardware device
static class	ComponentType.Machine$	Represents a Machine
static class	ComponentType.SequenceComponent$	Represents a sequence component e.g ocs_1, iris_1
static class	ComponentType.Sequencer$	Represents a component that controls one or more assemblies or sequencers
static 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(String messageManifest)

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,ComponentType>	lowerCaseNamesToValuesMap()
String	messageManifest()
String	name()	The name of ComponentType e.g.
static scala.collection.immutable.Map<String,ComponentType>	namesToValuesMap()
static final scala.collection.immutable.Map<String,ComponentType>	upperCaseNameValuesToMap()
static scala.collection.immutable.IndexedSeq<ComponentType>	values()	Returns a sequence of all component types
static final scala.collection.immutable.Map<ComponentType,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

entryName, enumeratum$EnumEntry$$stableEntryName

Constructor Details

ComponentType

public ComponentType(String messageManifest)

Method Details

namesToValuesMap

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

lowerCaseNamesToValuesMap

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

upperCaseNameValuesToMap

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

valuesToIndex

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

values

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

Returns a sequence of all component types

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

messageManifest

public String messageManifest()

name

public String name()

The name of ComponentType e.g. for HCD components, the name will be represented as hcd.

Returns:

(undocumented)