Identity (Commons Functor 1.0-SNAPSHOT API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.commons.functor.core.Identity<T>

Type Parameters:
T - the returned value type.

All Implemented Interfaces:

Serializable, Functor, UnaryFunction<T,T>, UnaryFunctor<T>, UnaryPredicate<T>
```
public final class Identity<T>
extends Object
implements UnaryFunction<T,T>, UnaryPredicate<T>, Serializable
```
Evaluates to its input argument. Tests to the boolean value of the Boolean-valued parameter. The test(java.lang.Object) method throws an exception if the parameter isn't a non-null Boolean.

Version:

$Revision: 1345136 $ $Date: 2012-06-01 08:47:06 -0400 (Fri, 01 Jun 2012) $

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Identity<Object> INSTANCE
A generic Identity<Object> instance.

Constructor Summary

Constructors
Constructor and Description

Identity()
Create a new Identity.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object that)`
`T`	`evaluate(T obj)` Evaluate this function.
`int`	`hashCode()`
`static <T> Identity<T>`	`instance()` Get an Identity instance.
`boolean`	`test(Boolean bool)` Test a Boolean object by returning its `booleanValue`.
`boolean`	`test(Object obj)` Evaluate this predicate.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - INSTANCE
```
public static final Identity<Object> INSTANCE
```
    A generic Identity<Object> instance.
- Constructor Detail
  - Identity
```
public Identity()
```
    Create a new Identity.
- Method Detail
  - evaluate
```
public T evaluate(T obj)
```
    Evaluate this function.
    
    Specified by:
    
    evaluate in interface UnaryFunction<T,T>
    
    Parameters:
    obj - the A object to evaluate
    
    Returns:
    the T result of this evaluation
  - test
```
public boolean test(Object obj)
```
    Evaluate this predicate.
    
    Specified by:
    
    test in interface UnaryPredicate<T>
    
    Parameters:
    obj - the A object to test
    
    Returns:
    the result of this test
  - test
```
public boolean test(Boolean bool)
```
    Test a Boolean object by returning its booleanValue.
    
    Parameters:
    bool - Boolean
    
    Returns:
    boolean
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - instance
```
public static <T> Identity<T> instance()
```
    Get an Identity instance.
    
    Type Parameters:
    T - the identity returned value type.
    
    Returns:
    Identity

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2003-2013 The Apache Software Foundation. All Rights Reserved.