Enum BytesTrie.Result

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

    public static enum BytesTrie.Result
    extends java.lang.Enum<BytesTrie.Result>
    Return values for BytesTrie.next(), CharsTrie.next() and similar methods.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FINAL_VALUE
      The input unit(s) continued a matching string and there is a value for the string so far.
      INTERMEDIATE_VALUE
      The input unit(s) continued a matching string and there is a value for the string so far.
      NO_MATCH
      The input unit(s) did not continue a matching string.
      NO_VALUE
      The input unit(s) continued a matching string but there is no value for the string so far.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean hasNext()
      Equivalent to (result==NO_VALUE || result==INTERMEDIATE_VALUE).
      boolean hasValue()
      Equivalent to (result==INTERMEDIATE_VALUE || result==FINAL_VALUE).
      boolean matches()
      Same as (result!
      static BytesTrie.Result valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static BytesTrie.Result[] 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
    • Enum Constant Detail

      • NO_MATCH

        public static final BytesTrie.Result NO_MATCH
        The input unit(s) did not continue a matching string. Once current()/next() return NO_MATCH, all further calls to current()/next() will also return NO_MATCH, until the trie is reset to its original state or to a saved state.
      • NO_VALUE

        public static final BytesTrie.Result NO_VALUE
        The input unit(s) continued a matching string but there is no value for the string so far. (It is a prefix of a longer string.)
      • FINAL_VALUE

        public static final BytesTrie.Result FINAL_VALUE
        The input unit(s) continued a matching string and there is a value for the string so far. This value will be returned by getValue(). No further input byte/unit can continue a matching string.
      • INTERMEDIATE_VALUE

        public static final BytesTrie.Result INTERMEDIATE_VALUE
        The input unit(s) continued a matching string and there is a value for the string so far. This value will be returned by getValue(). Another input byte/unit can continue a matching string.
    • Method Detail

      • values

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

        public static BytesTrie.Result 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
      • matches

        public boolean matches()
        Same as (result!=NO_MATCH).
        Returns:
        true if the input bytes/units so far are part of a matching string/byte sequence.
      • hasValue

        public boolean hasValue()
        Equivalent to (result==INTERMEDIATE_VALUE || result==FINAL_VALUE).
        Returns:
        true if there is a value for the input bytes/units so far.
        See Also:
        BytesTrie.getValue()
      • hasNext

        public boolean hasNext()
        Equivalent to (result==NO_VALUE || result==INTERMEDIATE_VALUE).
        Returns:
        true if another input byte/unit can continue a matching string.