Pair (Closure Templates)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.google.template.soy.internal.base.Pair<A,B>

```
public final class Pair<A,B>
extends Object
```
An immutable, semantic-free ordered pair of nullable values. These can be accessed using the first and second fields. Equality and hashing are defined in the natural way.
This type is devoid of semantics, best used for simple mechanical aggregations of unrelated values in implementation code. Avoid using it in your APIs, preferring an explicit type that conveys the exact semantics of the data. For example, instead of:
... use: This usually involves creating a new custom value-object type. This is difficult to do "by hand" in Java, but avoid the temptation to extend Pair to accomplish this; consider using the utilities com.google.common.auto.AutoValue to help you with this instead.

Field Summary

Fields
Modifier and Type Field and Description

A first
The first element of the pair.

B second
The second element of the pair.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)`
`int`	`hashCode()`
`static <A,B> Pair<A,B>`	`of(A first, B second)` Creates a new pair containing the given elements in order.
`String`	`toString()`

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

- Field Detail
  - first
```
public final A first
```
    The first element of the pair.
  - second
```
public final B second
```
    The second element of the pair.
- Method Detail
  - of
```
public static <A,B> Pair<A,B> of(@Nullable
                 A first,
                 @Nullable
                 B second)
```
    Creates a new pair containing the given elements in order.
  - equals
```
public boolean equals(@Nullable
             Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    This implementation returns a string in the form (first, second), where first and second are the String representations of the first and second elements of this pair, as given by String.valueOf(Object). Subclasses are free to override this behavior.
    
    Overrides:
    
    toString in class Object

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method