Package csw.prefix.models

Class Prefix

  • All Implemented Interfaces:
    java.io.Serializable, scala.Equals, scala.Product
    public class Prefix
extends java.lang.Object
implements scala.Product, java.io.Serializable
    A top level key for a parameter set: combination of subsystem and the subsystem's prefix e.g. tcs.filter.wheel, wfos.prog.cloudcover, etc

    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      Prefix()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Prefix apply​(Subsystem subsystem, java.lang.String componentName)
      A top level key for a parameter set: combination of subsystem and the subsystem's prefix e.g.
      static Prefix apply​(java.lang.String value)
      Creates a Prefix based on the given value of format tcs.filter.wheel and splits it to have tcs as subsystem and filter.wheel as componentName
      java.lang.String componentName()  
      Subsystem subsystem()  
      java.lang.String toString()
      String representation of prefix e.g.
      java.lang.String value()
      String representation of prefix e.g.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface scala.Equals

        canEqual, equals

      • Methods inherited from interface scala.Product

        productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

    • Constructor Detail

      • Prefix

        public Prefix()

    • Method Detail

      • apply

        public static Prefix apply​(java.lang.String value)
        Creates a Prefix based on the given value of format tcs.filter.wheel and splits it to have tcs as subsystem and filter.wheel as componentName

        Parameters:
        value - of format tcs.filter.wheel
        Returns:
        a Prefix instance

      • apply

        public static Prefix apply​(Subsystem subsystem,
                           java.lang.String componentName)
        A top level key for a parameter set: combination of subsystem and the subsystem's prefix e.g. tcs.filter.wheel, wfos.prog.cloudcover, etc

        Parameters:
        subsystem - component subsystem - tcs (TCS), wfos (WFOS)
        componentName - component name - filter.wheel, prog.cloudcover. It is changed to lowercase while constructing the Prefix.
        Returns:
        (undocumented)

      • componentName

        public java.lang.String componentName()

      • value

        public java.lang.String value()
        String representation of prefix e.g. tcs.filter.wheel where tcs is the subsystem name and filter.wheel is the component name
        Returns:
        (undocumented)

      • toString

        public java.lang.String toString()
        String representation of prefix e.g. tcs.filter.wheel where tcs is the subsystem name and filter.wheel is the component name
        Overrides:
        toString in class java.lang.Object
        Returns:
        (undocumented)