com.helger.commons.collection.pair.IPair Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.6+ Library with tons of utility classes required in all projects

There is a newer version: 9.5.5

/**
 * Copyright (C) 2014-2016 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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.
 */
package com.helger.commons.collection.pair;

import java.io.Serializable;
import java.util.Comparator;

import javax.annotation.Nonnull;

/**
 * Represents a basic read-only pair.
 *
 * @author Philip Helger
 * @param 
 *        First type.
 * @param 
 *        Second type.
 */
public interface IPair  extends Serializable
{
  /**
   * @return The first element. May be null depending on the
   *         implementation.
   */
  DATA1TYPE getFirst ();

  /**
   * @return The second element. May be null depending on the
   *         implementation.
   */
  DATA2TYPE getSecond ();

  @Nonnull
  static , T2> Comparator > getComparatorFirst ()
  {
    return Comparator.comparing (IPair::getFirst);
  }

  @Nonnull
  static > Comparator > getComparatorSecond ()
  {
    return Comparator.comparing (IPair::getSecond);
  }
}