Enum KeyTemplate.OutputPrefixType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<KeyTemplate.OutputPrefixType>
    Enclosing class:
    KeyTemplate

    public static enum KeyTemplate.OutputPrefixType
    extends java.lang.Enum<KeyTemplate.OutputPrefixType>
    Tink produces and accepts ciphertexts or signatures that consist of a prefix and a payload. The payload and its format is determined entirely by the primitive, but the prefix has to be one of the following 4 types:
    • Legacy: prefix is 5 bytes, starts with \x00 and followed by a 4-byte key id that is computed from the key material.
    • Crunchy: prefix is 5 bytes, starts with \x00 and followed by a 4-byte key id that is generated randomly.
    • Tink : prefix is 5 bytes, starts with \x01 and followed by 4-byte key id that is generated randomly.
    • Raw : prefix is 0 byte, i.e., empty.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static KeyTemplate.OutputPrefixType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static KeyTemplate.OutputPrefixType[] 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 KeyTemplate.OutputPrefixType[] 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 (KeyTemplate.OutputPrefixType c : KeyTemplate.OutputPrefixType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static KeyTemplate.OutputPrefixType 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