Enum Encodings

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

    public enum Encodings
    extends java.lang.Enum<Encodings>
    The encodings that are supported in the LogixNG log.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ASCII_ONE_BIT_PER_CHAR
      This encoding saves each state as a '0' or '1' character.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Class<? extends LogReaderDecoder> getDecoderClass()
      The class that is responsible to decode this encoding.
      java.lang.Class<? extends LogWriterEncoder> getEncoderClass()
      The class that is responsible to encode this encoding.
      static Encodings getEncodingFromName​(java.lang.String name)
      Get the encoding from the name of the encoding.
      java.lang.String getName()
      Get the name of the encoding.
      static Encodings valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Encodings[] 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, toString, valueOf
      • Methods inherited from class java.lang.Object

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

      • values

        public static Encodings[] 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 (Encodings c : Encodings.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Encodings 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
      • getName

        public java.lang.String getName()
        Get the name of the encoding. This name is stored in header of the log file.
        Returns:
        the name
      • getDecoderClass

        public java.lang.Class<? extends LogReaderDecodergetDecoderClass()
        The class that is responsible to decode this encoding.
        Returns:
        a class object for the decoder class
      • getEncoderClass

        public java.lang.Class<? extends LogWriterEncodergetEncoderClass()
        The class that is responsible to encode this encoding.
        Returns:
        a class object for the encoder class.
      • getEncodingFromName

        public static Encodings getEncodingFromName​(java.lang.String name)
        Get the encoding from the name of the encoding.
        Parameters:
        name - the name of the encoding
        Returns:
        the encoder
        Throws:
        java.lang.IllegalArgumentException - if there is no encoding with that name