Package org.apache.commons.lang3.time

Class DurationFormatUtils.Token

  • Enclosing class:
    DurationFormatUtils
    static final class DurationFormatUtils.Token
extends java.lang.Object
    Element that is parsed from the format pattern.

    • Constructor Summary

      Constructors 
      Constructor Description
      Token​(java.lang.CharSequence value, boolean optional, int optionalIndex)
      Wraps a token around a value.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      (package private) static boolean containsTokenWithValue​(DurationFormatUtils.Token[] tokens, java.lang.Object value)
      Helper method to determine if a set of tokens contain a value
      boolean equals​(java.lang.Object obj2)
      Supports equality of this Token to another Token.
      (package private) int getCount()
      Gets the current number of values represented
      (package private) java.lang.Object getValue()
      Gets the particular value this token represents.
      int hashCode()
      Returns a hash code for the token equal to the hash code for the token's value.
      (package private) void increment()
      Adds another one of the value
      java.lang.String toString()
      Represents this token as a String.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • value

        private final java.lang.CharSequence value

      • count

        private int count

      • optionalIndex

        private int optionalIndex

    • Constructor Detail

      • Token

        Token​(java.lang.CharSequence value,
      boolean optional,
      int optionalIndex)
        Wraps a token around a value. A value would be something like a 'Y'.
        Parameters:
        value - value to wrap, non-null.
        optional - whether the token is optional
        optionalIndex - the index of the optional token within the pattern

    • Method Detail

      • containsTokenWithValue

        static boolean containsTokenWithValue​(DurationFormatUtils.Token[] tokens,
                                      java.lang.Object value)
        Helper method to determine if a set of tokens contain a value
        Parameters:
        tokens - set to look in
        value - to look for
        Returns:
        boolean true if contained

      • equals

        public boolean equals​(java.lang.Object obj2)
        Supports equality of this Token to another Token.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj2 - Object to consider equality of
        Returns:
        boolean true if equal

      • getCount

        int getCount()
        Gets the current number of values represented
        Returns:
        int number of values represented

      • getValue

        java.lang.Object getValue()
        Gets the particular value this token represents.
        Returns:
        Object value, non-null.

      • hashCode

        public int hashCode()
        Returns a hash code for the token equal to the hash code for the token's value. Thus 'TT' and 'TTTT' will have the same hash code.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        The hash code for the token

      • increment

        void increment()
        Adds another one of the value

      • toString

        public java.lang.String toString()
        Represents this token as a String.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String representation of the token