Enum DbKeyCompressedFunnel

  • All Implemented Interfaces:
    Funnel<DbKey>, Serializable, Comparable<DbKeyCompressedFunnel>

    public enum DbKeyCompressedFunnel
    extends Enum<DbKeyCompressedFunnel>
    implements Funnel<DbKey>
    A funnel for a database key. Encodes the key in the following format: the number of significant bits in the key in unsigned LEB128 format; then the key bytes including significant bits (e.g., if there are 12 significant bits, ceil(12/8) = 2 bytes of the key will be written to the sink).
    • Method Detail

      • values

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

        public static DbKeyCompressedFunnel valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • funnel

        public void funnel​(DbKey from,
                           PrimitiveSink into)
        Description copied from interface: Funnel
        Sends a stream of data from the from object into the sink into. There is no requirement that this data be complete enough to fully reconstitute the object later.
        Specified by:
        funnel in interface Funnel<DbKey>
      • dbKeyCompressedFunnel

        public static Funnel<DbKey> dbKeyCompressedFunnel()