Есть ли веская причина, почему в Java нет Pair<L,R>? Что было бы эквивалентом этой конструкции С++? Я бы предпочел избежать переоценки своих собственных.
Кажется, что 1.6 предоставляет нечто подобное (AbstractMap.SimpleEntry<K,V>), но это выглядит довольно запутанным.
В поток на comp.lang.java.help, Hunter Gratzner дает некоторые аргументы против наличия конструкции Pair в Java. Основной аргумент состоит в том, что класс Pair не передает семантики о взаимосвязи между двумя значениями (откуда вы знаете, что означает "первый" и "второй"?).
Лучшая практика - написать очень простой класс, например, предложенный Майком, для каждого приложения, которое вы сделали бы из класса Pair. Map.Entry - пример пары, несущей в себе свое значение.
Подводя итог, по моему мнению, лучше иметь класс Position(x,y), класс Range(begin,end) и класс Entry(key,value), а не общий Pair(first,second), который не говорит мне ничего о том, что он предположил сделать.
Это Java. Вы должны создать свой собственный класс Pair с описательными именами классов и полей, а не учитывать, что вы изобретете колесо, написав hashCode()/equals() или реализуя Comparable снова и снова.
Совместимый с HashMap класс пары:
public class Pair<A, B> {
private A first;
private B second;
public Pair(A first, B second) {
super();
this.first = first;
this.second = second;
}
public int hashCode() {
int hashFirst = first != null ? first.hashCode() : 0;
int hashSecond = second != null ? second.hashCode() : 0;
return (hashFirst + hashSecond) * hashSecond + hashFirst;
}
public boolean equals(Object other) {
if (other instanceof Pair) {
Pair otherPair = (Pair) other;
return
(( this.first == otherPair.first ||
( this.first != null && otherPair.first != null &&
this.first.equals(otherPair.first))) &&
( this.second == otherPair.second ||
( this.second != null && otherPair.second != null &&
this.second.equals(otherPair.second))) );
}
return false;
}
public String toString()
{
return "(" + first + ", " + second + ")";
}
public A getFirst() {
return first;
}
public void setFirst(A first) {
this.first = first;
}
public B getSecond() {
return second;
}
public void setSecond(B second) {
this.second = second;
}
}
Самая короткая пара, которую я могу придумать, - это Lombok:
@Data
@AllArgsConstructor(staticName = "of")
public class Pair<F, S> {
private F first;
private S second;
}
Он обладает всеми преимуществами ответа от @arturh (кроме сопоставимости), имеет hashCode, equals, toString и статический "конструктор".
Apache Commons Lang 3.0+ имеет несколько классов Pair: http://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/tuple/package-summary.html
Другой способ реализации пары с.
Простой factory, поэтому вам не нужно предоставлять типы. например Pair.of( "hello", 1);
public class Pair<FIRST, SECOND> implements Comparable<Pair<FIRST, SECOND>> {
public final FIRST first;
public final SECOND second;
private Pair(FIRST first, SECOND second) {
this.first = first;
this.second = second;
}
public static <FIRST, SECOND> Pair<FIRST, SECOND> of(FIRST first,
SECOND second) {
return new Pair<FIRST, SECOND>(first, second);
}
@Override
public int compareTo(Pair<FIRST, SECOND> o) {
int cmp = compare(first, o.first);
return cmp == 0 ? compare(second, o.second) : cmp;
}
// todo move this to a helper class.
private static int compare(Object o1, Object o2) {
return o1 == null ? o2 == null ? 0 : -1 : o2 == null ? +1
: ((Comparable) o1).compareTo(o2);
}
@Override
public int hashCode() {
return 31 * hashcode(first) + hashcode(second);
}
// todo move this to a helper class.
private static int hashcode(Object o) {
return o == null ? 0 : o.hashCode();
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof Pair))
return false;
if (this == obj)
return true;
return equal(first, ((Pair) obj).first)
&& equal(second, ((Pair) obj).second);
}
// todo move this to a helper class.
private boolean equal(Object o1, Object o2) {
return o1 == null ? o2 == null : (o1 == o2 || o1.equals(o2));
}
@Override
public String toString() {
return "(" + first + ", " + second + ')';
}
}
Как насчет http://www.javatuples.org/index.html Я нашел это очень полезным.
Javatuples предлагает вам классы кортежей от одного до десяти элементов:
Unit<A> (1 element)
Pair<A,B> (2 elements)
Triplet<A,B,C> (3 elements)
Quartet<A,B,C,D> (4 elements)
Quintet<A,B,C,D,E> (5 elements)
Sextet<A,B,C,D,E,F> (6 elements)
Septet<A,B,C,D,E,F,G> (7 elements)
Octet<A,B,C,D,E,F,G,H> (8 elements)
Ennead<A,B,C,D,E,F,G,H,I> (9 elements)
Decade<A,B,C,D,E,F,G,H,I,J> (10 elements)
Это зависит от того, для чего вы хотите его использовать. Типичная причина для этого - перебрать карты, для которых вы просто это делаете (Java 5 +):
Map<String, Object> map = ... ; // just an example
for (Map.Entry<String, Object> entry : map.entrySet()) {
System.out.printf("%s -> %s\n", entry.getKey(), entry.getValue());
}
android предоставляет класс Pair (http://developer.android.com/reference/android/util/Pair.html), здесь реализация:
public class Pair<F, S> {
public final F first;
public final S second;
public Pair(F first, S second) {
this.first = first;
this.second = second;
}
@Override
public boolean equals(Object o) {
if (!(o instanceof Pair)) {
return false;
}
Pair<?, ?> p = (Pair<?, ?>) o;
return Objects.equal(p.first, first) && Objects.equal(p.second, second);
}
@Override
public int hashCode() {
return (first == null ? 0 : first.hashCode()) ^ (second == null ? 0 : second.hashCode());
}
public static <A, B> Pair <A, B> create(A a, B b) {
return new Pair<A, B>(a, b);
}
}
Самая большая проблема, вероятно, в том, что нельзя гарантировать неизменность A и B (см. Как обеспечить неизменность параметров типа), поэтому hashCode() может дать непоследовательные результаты для той же пары после вставляются в коллекцию, например (это даст поведение undefined, см. Определение равных в терминах изменяемых полей). Для конкретного (не общего) класса Pair программист может обеспечить неизменность, тщательно выбирая A и B, чтобы быть неизменными.
В любом случае, очистка общих предупреждений от ответа @PeterLawrey (java 1.7):
public class Pair<A extends Comparable<? super A>,
B extends Comparable<? super B>>
implements Comparable<Pair<A, B>> {
public final A first;
public final B second;
private Pair(A first, B second) {
this.first = first;
this.second = second;
}
public static <A extends Comparable<? super A>,
B extends Comparable<? super B>>
Pair<A, B> of(A first, B second) {
return new Pair<A, B>(first, second);
}
@Override
public int compareTo(Pair<A, B> o) {
int cmp = o == null ? 1 : (this.first).compareTo(o.first);
return cmp == 0 ? (this.second).compareTo(o.second) : cmp;
}
@Override
public int hashCode() {
return 31 * hashcode(first) + hashcode(second);
}
// TODO : move this to a helper class.
private static int hashcode(Object o) {
return o == null ? 0 : o.hashCode();
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof Pair))
return false;
if (this == obj)
return true;
return equal(first, ((Pair<?, ?>) obj).first)
&& equal(second, ((Pair<?, ?>) obj).second);
}
// TODO : move this to a helper class.
private boolean equal(Object o1, Object o2) {
return o1 == o2 || (o1 != null && o1.equals(o2));
}
@Override
public String toString() {
return "(" + first + ", " + second + ')';
}
}
Дополнения/исправления очень приветствуются:) В частности, я не совсем уверен в моем использовании Pair<?, ?>.
Для получения дополнительной информации о том, почему этот синтаксис см. Убедитесь, что объекты реализуют Comparable и для подробного объяснения Как реализовать общий max(Comparable a, Comparable b) в Java?
Благая весть JavaFX имеет ключевое значение Pair.
просто добавьте javafx в качестве зависимости и импортируйте javafx.util.Pair;
и используйте просто как в c++.
Pair <Key, Value>
например,
Pair <Integer, Integer> pr = new Pair<Integer, Integer>()
pr.get(key);// will return corresponding value
По-моему, в Java нет пары, потому что, если вы хотите добавить дополнительные функции непосредственно в пару (например, Comparable), вы должны связать типы. В С++ нам просто все равно, и если типы, составляющие пару, не имеют operator <, pair::operator < тоже не будет компилироваться.
Пример сравнимого без ограничения:
public class Pair<F, S> implements Comparable<Pair<? extends F, ? extends S>> {
public final F first;
public final S second;
/* ... */
public int compareTo(Pair<? extends F, ? extends S> that) {
int cf = compare(first, that.first);
return cf == 0 ? compare(second, that.second) : cf;
}
//Why null is decided to be less than everything?
private static int compare(Object l, Object r) {
if (l == null) {
return r == null ? 0 : -1;
} else {
return r == null ? 1 : ((Comparable) (l)).compareTo(r);
}
}
}
/* ... */
Pair<Thread, HashMap<String, Integer>> a = /* ... */;
Pair<Thread, HashMap<String, Integer>> b = /* ... */;
//Runtime error here instead of compile error!
System.out.println(a.compareTo(b));
Пример сравнения с проверкой времени компиляции для сопоставимых аргументов типа:
public class Pair<
F extends Comparable<? super F>,
S extends Comparable<? super S>
> implements Comparable<Pair<? extends F, ? extends S>> {
public final F first;
public final S second;
/* ... */
public int compareTo(Pair<? extends F, ? extends S> that) {
int cf = compare(first, that.first);
return cf == 0 ? compare(second, that.second) : cf;
}
//Why null is decided to be less than everything?
private static <
T extends Comparable<? super T>
> int compare(T l, T r) {
if (l == null) {
return r == null ? 0 : -1;
} else {
return r == null ? 1 : l.compareTo(r);
}
}
}
/* ... */
//Will not compile because Thread is not Comparable<? super Thread>
Pair<Thread, HashMap<String, Integer>> a = /* ... */;
Pair<Thread, HashMap<String, Integer>> b = /* ... */;
System.out.println(a.compareTo(b));
Это хорошо, но на этот раз вы не можете использовать несопоставимые типы как аргументы типа в Pair. В некоторых классах утилиты можно использовать множество компараторов для пары, но люди С++ могут не получить их. Другой способ - написать много классов в иерархии типов с разными ограничениями на аргументы типа, но существует слишком много возможных границ и их комбинаций...
Как уже отмечалось многими другими, это действительно зависит от варианта использования, если класс Pair полезен или нет.
Я считаю, что для частной вспомогательной функции вполне законно использовать класс Pair, если это делает ваш код более удобочитаемым и не стоит усилий для создания еще одного класса значений со всем его кодовым табличным кодом.
С другой стороны, если ваш уровень абстракции требует четкого документирования семантики класса, который содержит два объекта или значения, тогда вы должны написать для него класс. Обычно это случай, если данные являются бизнес-объектом.
Как всегда, это требует квалифицированного суждения.
Для вашего второго вопроса я рекомендую класс Pair из библиотек Apache Commons. Это можно рассматривать как расширенные стандартные библиотеки для Java:
https://commons.apache.org/proper/commons-lang/apidocs/org/apache/commons/lang3/tuple/Pair.html
Вы также можете посмотреть на Apache Commons EqualsBuilder, HashCodeBuilder и ToStringBuilder, которые упрощают запись классов значений для ваших бизнес-объектов.
JavaFX (который поставляется в комплекте с Java 8) имеет Pair < A, B > class
Вы можете использовать служебный класс javafx, Pair, который служит той же цели, что и пара & lt;> в c++. https://docs.oracle.com/javafx/2/api/javafx/util/Pair.html
Map.Entry интерфейс близок к паре С++. Посмотрите на конкретную реализацию, например AbstractMap.SimpleEntry и AbstractMap.SimpleImmutableEntry Первый элемент - getKey(), а второй - getValue().
Collections.singletonMap(left, rigth);
В соответствии с природой языка Java, я полагаю, что людям на самом деле не требуется Pair, интерфейс, как правило, нужен им. Вот пример:
interface Pair<L, R> {
public L getL();
public R getR();
}
Итак, когда люди хотят вернуть два значения, они могут сделать следующее:
... //Calcuate the return value
final Integer v1 = result1;
final String v2 = result2;
return new Pair<Integer, String>(){
Integer getL(){ return v1; }
String getR(){ return v2; }
}
Это довольно легкое решение, и оно отвечает на вопрос "Что такое семантика Pair<L,R>?". Ответ заключается в том, что это сборка интерфейса с двумя (может быть разными) типами, и у нее есть методы для возврата каждого из них. Это зависит от вас, чтобы добавить к нему еще одну семантику. Например, если вы используете Position и REALLY хотите указать ее в своем коде, вы можете определить PositionX и PositionY, который содержит Integer, чтобы составить Pair<PositionX,PositionY>. Если JSR 308 доступен, вы также можете использовать Pair<@PositionX Integer, @PositionY Ingeger>, чтобы упростить это.
EDIT:
Одна вещь, которую я должен указать здесь, состоит в том, что приведенное выше определение явно связывает имя параметра типа и имя метода. Это ответ тем, кто утверждает, что a Pair - отсутствие семантической информации. На самом деле метод getL означает "дать мне элемент, соответствующий типу параметра типа L", что что-то значит.
EDIT: Вот простой класс утилиты, который может облегчить жизнь:
class Pairs {
static <L,R> Pair<L,R> makePair(final L l, final R r){
return new Pair<L,R>(){
public L getL() { return l; }
public R getR() { return r; }
};
}
}
использование:
return Pairs.makePair(new Integer(100), "123");
Несмотря на синтаксически подобный подход, Java и С++ имеют очень разные парадигмы. Написание С++, как Java, является плохим С++, и писать Java, как С++, является плохой Java.
При использовании IDE на основе отражения, например Eclipse, запись функциональности класса "пара" выполняется быстро и просто. Создайте класс, определите два поля, используйте различные опции меню "Создать XX", чтобы заполнить класс за считанные секунды. Возможно, вам нужно будет ввести "compareTo" реальный быстрый, если вы хотите интерфейс Comparable.
С отдельными параметрами декларации/определения в языке генераторы кода на С++ не так хороши, поэтому ручная работа с небольшими полезными классами - это более трудоемкая скука. Поскольку пара является шаблоном, вам не нужно оплачивать функции, которые вы не используете, а средство typedef позволяет назначать значащие имена для кода, поэтому возражения о "без семантики" действительно не задерживаются.
Пара была бы хорошим материалом, чтобы стать базовой конструкцией для сложных дженериков, например, это из моего кода:
WeakHashMap<Pair<String, String>, String> map = ...
Это то же самое, что и Haskell Tuple
Для языков программирования, таких как Java, альтернативная структура данных, используемая большинством программистов для представления пары, такой как структуры данных, представляет собой два массива, и к ним обращаются через один и тот же индекс
example: http://www-igm.univ-mlv.fr/~lecroq/string/node8.html#SECTION0080
Это не идеально, поскольку данные должны быть связаны вместе, но также оказаться довольно дешевыми. Кроме того, если ваш вариант использования требует хранения координат, тогда лучше создать собственную структуру данных.
В моей библиотеке что-то вроде этого
public class Pair<First,Second>{.. }
Вы можете использовать библиотеку Google AutoValue - https://github.com/google/auto/tree/master/value.
Вы создаете очень маленький абстрактный класс и аннотируете его с помощью @AutoValue, а обработчик аннотации генерирует для вас конкретный класс с семантикой значения.
Вот несколько библиотек, которые для вашего удобства имеют несколько степеней:
Были упомянуты другие библиотеки, содержащие как минимум кортеж Pair.
В частности, в контексте функционального программирования, в котором используется много структурной типизации, а не номинальной типизации (как указано в принятом ответе), эти библиотеки и их кортежи приходят очень кстати.
Брайан Гетц, Пол Сандоз и Стюарт Маркс объясните, почему во время сеанса QA в Devoxx'14.
Наличие родового парного класса в стандартной библиотеке превратится в технический долг после значения типов.
См. также: Есть ли в Java SE 8 пары или кортежи?
Простой способ. Объект [] - может использоваться как кортеж без ограничений
Я заметил, что все реализации Pair усеяны здесь атрибутом, означающим порядок двух значений. Когда я думаю о паре, я думаю о комбинации двух предметов, в которой порядок этих двух не имеет значения. Здесь моя реализация неупорядоченной пары с hashCode и equals переопределяет для обеспечения желаемого поведения в коллекциях. Также клонируется.
/**
* The class <code>Pair</code> models a container for two objects wherein the
* object order is of no consequence for equality and hashing. An example of
* using Pair would be as the return type for a method that needs to return two
* related objects. Another good use is as entries in a Set or keys in a Map
* when only the unordered combination of two objects is of interest.<p>
* The term "object" as being a one of a Pair can be loosely interpreted. A
* Pair may have one or two <code>null</code> entries as values. Both values
* may also be the same object.<p>
* Mind that the order of the type parameters T and U is of no importance. A
* Pair<T, U> can still return <code>true</code> for method <code>equals</code>
* called with a Pair<U, T> argument.<p>
* Instances of this class are immutable, but the provided values might not be.
* This means the consistency of equality checks and the hash code is only as
* strong as that of the value types.<p>
*/
public class Pair<T, U> implements Cloneable {
/**
* One of the two values, for the declared type T.
*/
private final T object1;
/**
* One of the two values, for the declared type U.
*/
private final U object2;
private final boolean object1Null;
private final boolean object2Null;
private final boolean dualNull;
/**
* Constructs a new <code>Pair<T, U></code> with T object1 and U object2 as
* its values. The order of the arguments is of no consequence. One or both of
* the values may be <code>null</code> and both values may be the same object.
*
* @param object1 T to serve as one value.
* @param object2 U to serve as the other value.
*/
public Pair(T object1, U object2) {
this.object1 = object1;
this.object2 = object2;
object1Null = object1 == null;
object2Null = object2 == null;
dualNull = object1Null && object2Null;
}
/**
* Gets the value of this Pair provided as the first argument in the constructor.
*
* @return a value of this Pair.
*/
public T getObject1() {
return object1;
}
/**
* Gets the value of this Pair provided as the second argument in the constructor.
*
* @return a value of this Pair.
*/
public U getObject2() {
return object2;
}
/**
* Returns a shallow copy of this Pair. The returned Pair is a new instance
* created with the same values as this Pair. The values themselves are not
* cloned.
*
* @return a clone of this Pair.
*/
@Override
public Pair<T, U> clone() {
return new Pair<T, U>(object1, object2);
}
/**
* Indicates whether some other object is "equal" to this one.
* This Pair is considered equal to the object if and only if
* <ul>
* <li>the Object argument is not null,
* <li>the Object argument has a runtime type Pair or a subclass,
* </ul>
* AND
* <ul>
* <li>the Object argument refers to this pair
* <li>OR this pair values are both null and the other pair values are both null
* <li>OR this pair has one null value and the other pair has one null value and
* the remaining non-null values of both pairs are equal
* <li>OR both pairs have no null values and have value tuples <v1, v2> of
* this pair and <o1, o2> of the other pair so that at least one of the
* following statements is true:
* <ul>
* <li>v1 equals o1 and v2 equals o2
* <li>v1 equals o2 and v2 equals o1
* </ul>
* </ul>
* In any other case (such as when this pair has two null parts but the other
* only one) this method returns false.<p>
* The type parameters that were used for the other pair are of no importance.
* A Pair<T, U> can return <code>true</code> for equality testing with
* a Pair<T, V> even if V is neither a super- nor subtype of U, should
* the the value equality checks be positive or the U and V type values
* are both <code>null</code>. Type erasure for parameter types at compile
* time means that type checks are delegated to calls of the <code>equals</code>
* methods on the values themselves.
*
* @param obj the reference object with which to compare.
* @return true if the object is a Pair equal to this one.
*/
@Override
public boolean equals(Object obj) {
if(obj == null)
return false;
if(this == obj)
return true;
if(!(obj instanceof Pair<?, ?>))
return false;
final Pair<?, ?> otherPair = (Pair<?, ?>)obj;
if(dualNull)
return otherPair.dualNull;
//After this we're sure at least one part in this is not null
if(otherPair.dualNull)
return false;
//After this we're sure at least one part in obj is not null
if(object1Null) {
if(otherPair.object1Null) //Yes: this and other both have non-null part2
return object2.equals(otherPair.object2);
else if(otherPair.object2Null) //Yes: this has non-null part2, other has non-null part1
return object2.equals(otherPair.object1);
else //Remaining case: other has no non-null parts
return false;
} else if(object2Null) {
if(otherPair.object2Null) //Yes: this and other both have non-null part1
return object1.equals(otherPair.object1);
else if(otherPair.object1Null) //Yes: this has non-null part1, other has non-null part2
return object1.equals(otherPair.object2);
else //Remaining case: other has no non-null parts
return false;
} else {
//Transitive and symmetric requirements of equals will make sure
//checking the following cases are sufficient
if(object1.equals(otherPair.object1))
return object2.equals(otherPair.object2);
else if(object1.equals(otherPair.object2))
return object2.equals(otherPair.object1);
else
return false;
}
}
/**
* Returns a hash code value for the pair. This is calculated as the sum
* of the hash codes for the two values, wherein a value that is <code>null</code>
* contributes 0 to the sum. This implementation adheres to the contract for
* <code>hashCode()</code> as specified for <code>Object()</code>. The returned
* value hash code consistently remain the same for multiple invocations
* during an execution of a Java application, unless at least one of the pair
* values has its hash code changed. That would imply information used for
* equals in the changed value(s) has also changed, which would carry that
* change onto this class' <code>equals</code> implementation.
*
* @return a hash code for this Pair.
*/
@Override
public int hashCode() {
int hashCode = object1Null ? 0 : object1.hashCode();
hashCode += (object2Null ? 0 : object2.hashCode());
return hashCode;
}
}
Эта реализация была правильно протестирована на модуле, и было проверено использование в Set и Map.
Примечание. Я не утверждаю, что предлагаю опубликовать это в общедоступном домене. Это код, который я только что написал для использования в приложении, поэтому, если вы собираетесь его использовать, пожалуйста, воздержитесь от прямого копирования и беспорядка с комментариями и именами. Поймай мой дрейф?
Если кто-то хочет простую и простую в использовании версию, я сделал доступным в https://github.com/lfac-pt/Java-Pair. Кроме того, улучшения очень приветствуются!
com.sun.tools.javac.util.Pair - простая реализация пары. Его можно найти в jdk1.7.0_51\lib\tools.jar.
Помимо org.apache.commons.lang3.tuple.Pair, это не просто интерфейс.
другая краткая реализация ломбок
import lombok.Value;
@Value(staticConstructor = "of")
public class Pair<F, S> {
private final F first;
private final S second;
}
public class Pair<K, V> {
private final K element0;
private final V element1;
public static <K, V> Pair<K, V> createPair(K key, V value) {
return new Pair<K, V>(key, value);
}
public Pair(K element0, V element1) {
this.element0 = element0;
this.element1 = element1;
}
public K getElement0() {
return element0;
}
public V getElement1() {
return element1;
}
}
использование:
Pair<Integer, String> pair = Pair.createPair(1, "test");
pair.getElement0();
pair.getElement1();
Неизменяемость, только пара!