Package org.apache.commons.functor.core.collection

Class Size<A>

  • Type Parameters:
    A - the function argument type.
    All Implemented Interfaces:
    java.io.Serializable, Functor, UnaryFunction<A,​java.lang.Integer>, UnaryFunctor<A>
    public final class Size<A>
extends java.lang.Object
implements UnaryFunction<A,​java.lang.Integer>, java.io.Serializable
    Returns the size of the specified Collection, or the length of the specified array or String.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static Size<java.lang.Object> INSTANCE
      A static Size instance reference.
      private static long serialVersionUID
      serialVersionUID declaration.

    • Constructor Summary

      Constructors 
      Constructor Description
      Size()
      Create a new Size.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object that)
      Indicates whether some other object is "equal to" this functor.
      java.lang.Integer evaluate​(java.lang.Object obj)
      Evaluate this function.
      private int evaluate​(java.lang.String str)
      Evaluate a String.
      private int evaluate​(java.util.Collection<?> col)
      Evaluate a Collection.
      private int evaluateArray​(java.lang.Object array)
      Evaluate an array.
      int hashCode()
      Returns a hash code for this functor adhering to the general Object.hashCode contract.
      static Size<java.lang.Object> instance()
      Get a Size instance.
      java.lang.String toString()
      Returns a human readable description of this functor.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        serialVersionUID declaration.
        See Also:
        Constant Field Values

      • INSTANCE

        private static final Size<java.lang.Object> INSTANCE
        A static Size instance reference.

    • Constructor Detail

      • Size

        public Size()
        Create a new Size.

    • Method Detail

      • evaluate

        public java.lang.Integer evaluate​(java.lang.Object obj)
        Evaluate this function.
        Specified by:
        evaluate in interface UnaryFunction<A,​java.lang.Integer>
        Parameters:
        obj - the A object to evaluate
        Returns:
        the T result of this evaluation

      • equals

        public boolean equals​(java.lang.Object that)
        Indicates whether some other object is "equal to" this functor. This method must adhere to general Object.equals contract. Additionally, this method can return true only if the specified Object implements the same functor interface and is known to produce the same results and/or side-effects for the same arguments (if any).

        While implementators are strongly encouraged to override the default Object implementation of this method, note that the default Object implementation does in fact adhere to the functor equals contract.

        Specified by:
        equals in interface Functor
        Overrides:
        equals in class java.lang.Object
        Parameters:
        that - the object to compare this functor to
        Returns:
        true iff the given object implements this functor interface, and is known to produce the same results and/or side-effects for the same arguments (if any).
        See Also:
        Functor.hashCode()

      • hashCode

        public int hashCode()
        Returns a hash code for this functor adhering to the general Object.hashCode contract. Implementators are strongly encouraged but not strictly required to override the default Object implementation of this method.
        Specified by:
        hashCode in interface Functor
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a hash code for this functor
        See Also:
        Functor.equals(java.lang.Object)

      • toString

        public java.lang.String toString()
        Returns a human readable description of this functor. Implementators are strongly encouraged but not strictly required to override the default Object implementation of this method.
        Specified by:
        toString in interface Functor
        Overrides:
        toString in class java.lang.Object
        Returns:
        a human readable description of this functor

      • instance

        public static Size<java.lang.Object> instance()
        Get a Size instance.
        Returns:
        Size

      • evaluate

        private int evaluate​(java.util.Collection<?> col)
        Evaluate a Collection.
        Parameters:
        col - to evaluate
        Returns:
        Integer

      • evaluate

        private int evaluate​(java.lang.String str)
        Evaluate a String.
        Parameters:
        str - to evaluate
        Returns:
        Integer

      • evaluateArray

        private int evaluateArray​(java.lang.Object array)
        Evaluate an array.
        Parameters:
        array - to evaluate
        Returns:
        Integer