| career | drupal | java | mac | mysql | perl | scala | uml | unix  

Java example source code file (

This example Java source code file ( is included in the "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

comparable, immutabletriple, object, override, serializable, string, suppresswarnings, triple

The Java example source code

 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * See the License for the specific language governing permissions and
 * limitations under the License.
package org.apache.commons.lang3.tuple;


import org.apache.commons.lang3.ObjectUtils;
import org.apache.commons.lang3.builder.CompareToBuilder;

 * <p>A triple consisting of three elements.

* * <p>This class is an abstract implementation defining the basic API. * It refers to the elements as 'left', 'middle' and 'right'.</p> * * <p>Subclass implementations may be mutable or immutable. * However, there is no restriction on the type of the stored objects that may be stored. * If mutable objects are stored in the triple, then the triple itself effectively becomes mutable.</p> * * @param <L> the left element type * @param <M> the middle element type * @param <R> the right element type * * @since 3.2 */ public abstract class Triple<L, M, R> implements Comparable>, Serializable { /** Serialization version */ private static final long serialVersionUID = 1L; /** * <p>Obtains an immutable triple of from three objects inferring the generic types.

* * <p>This factory allows the triple to be created using inference to * obtain the generic types.</p> * * @param <L> the left element type * @param <M> the middle element type * @param <R> the right element type * @param left the left element, may be null * @param middle the middle element, may be null * @param right the right element, may be null * @return a triple formed from the three parameters, not null */ public static <L, M, R> Triple of(final L left, final M middle, final R right) { return new ImmutableTriple<L, M, R>(left, middle, right); } //----------------------------------------------------------------------- /** * <p>Gets the left element from this triple.

* * @return the left element, may be null */ public abstract L getLeft(); /** * <p>Gets the middle element from this triple.

* * @return the middle element, may be null */ public abstract M getMiddle(); /** * <p>Gets the right element from this triple.

* * @return the right element, may be null */ public abstract R getRight(); //----------------------------------------------------------------------- /** * <p>Compares the triple based on the left element, followed by the middle element, * finally the right element. * The types must be {@code Comparable}.</p> * * @param other the other triple, not null * @return negative if this is less, zero if equal, positive if greater */ @Override public int compareTo(final Triple<L, M, R> other) { return new CompareToBuilder().append(getLeft(), other.getLeft()) .append(getMiddle(), other.getMiddle()) .append(getRight(), other.getRight()).toComparison(); } /** * <p>Compares this triple to another based on the three elements.

* * @param obj the object to compare to, null returns false * @return true if the elements of the triple are equal */ @SuppressWarnings( "deprecation" ) // ObjectUtils.equals(Object, Object) has been deprecated in 3.2 @Override public boolean equals(final Object obj) { if (obj == this) { return true; } if (obj instanceof Triple<?, ?, ?>) { final Triple<?, ?, ?> other = (Triple) obj; return ObjectUtils.equals(getLeft(), other.getLeft()) && ObjectUtils.equals(getMiddle(), other.getMiddle()) && ObjectUtils.equals(getRight(), other.getRight()); } return false; } /** * <p>Returns a suitable hash code.

* * @return the hash code */ @Override public int hashCode() { return (getLeft() == null ? 0 : getLeft().hashCode()) ^ (getMiddle() == null ? 0 : getMiddle().hashCode()) ^ (getRight() == null ? 0 : getRight().hashCode()); } /** * <p>Returns a String representation of this triple using the format {@code ($left,$middle,$right)}.

* * @return a string describing this object, not null */ @Override public String toString() { return "(" + getLeft() + "," + getMiddle() + "," + getRight() + ")"; } /** * <p>Formats the receiver using the given format.

* * <p>This uses {@link java.util.Formattable} to perform the formatting. Three variables may * be used to embed the left and right elements. Use {@code %1$s} for the left * element, {@code %2$s} for the middle and {@code %3$s} for the right element. * The default format used by {@code toString()} is {@code (%1$s,%2$s,%3$s)}.</p> * * @param format the format string, optionally containing {@code %1$s}, {@code %2$s} and {@code %3$s}, not null * @return the formatted string, not null */ public String toString(final String format) { return String.format(format, getLeft(), getMiddle(), getRight()); } }

Other Java examples (source code examples)

Here is a short list of links related to this Java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller


new blog posts


Copyright 1998-2021 Alvin Alexander,
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.