Enum OMRSEventProtocolVersion

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OMRSEventProtocolVersion>

    public enum OMRSEventProtocolVersion
    extends java.lang.Enum<OMRSEventProtocolVersion>
    implements java.io.Serializable
    OMRSEventProtocolVersion provides the identifier for the version number of the event payload. There is only one version at the moment which is why it looks a little sad.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      V1  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Return the default description for the star rating for this enum instance.
      java.lang.String getName()
      Return the default symbol for this enum instance.
      int getOrdinal()
      Return the code for this enum instance
      java.lang.String toString()
      Standard toString method.
      static OMRSEventProtocolVersion valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static OMRSEventProtocolVersion[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • values

        public static OMRSEventProtocolVersion[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (OMRSEventProtocolVersion c : OMRSEventProtocolVersion.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static OMRSEventProtocolVersion valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getOrdinal

        public int getOrdinal()
        Return the code for this enum instance
        Returns:
        int star rating code
      • getName

        public java.lang.String getName()
        Return the default symbol for this enum instance.
        Returns:
        String default symbol
      • getDescription

        public java.lang.String getDescription()
        Return the default description for the star rating for this enum instance.
        Returns:
        String default description
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class java.lang.Enum<OMRSEventProtocolVersion>
        Returns:
        print out of variables in a JSON-style