javatools.datatypes

Class Pair<F,S>

java.lang.Object

javatools.datatypes.Pair<F,S>

All Implemented Interfaces:

Comparable<Pair<F,S>>

Direct Known Subclasses:

Triple

public class Pair<F,S>
extends Object
implements Comparable<Pair<F,S>>

Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. This class provides the simple datatype of a pair

Field Summary

Fields

Modifier and Type	Field and Description
F	first Holds the first component
S	second Holds the second component

Constructor Summary

Constructors

Constructor and Description
Pair() Constructs an empty pair
Pair(F first, S second) Constructs a Pair

Method Summary

Modifier and Type	Method and Description
int	compareTo(Pair<F,S> o)
boolean	equals(Object obj)
F	first() Returns the first
int	hashCode()
S	second() Returns the second
void	setFirst(F first) Sets the first
void	setSecond(S second) Sets the second
String	toString() Returns "first/second"

Methods inherited from class java.lang.Object

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

Field Detail

first

public F first

Holds the first component

second

public S second

Holds the second component

Constructor Detail

Pair

public Pair(F first,
            S second)

Constructs a Pair

Pair

public Pair()

Constructs an empty pair

Method Detail

first

public F first()

Returns the first

setFirst

public void setFirst(F first)

Sets the first

second

public S second()

Returns the second

setSecond

public void setSecond(S second)

Sets the second

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Returns "first/second"

Overrides:

toString in class Object

compareTo

public int compareTo(Pair<F,S> o)

Specified by:

compareTo in interface Comparable<Pair<F,S>>