com.helger.collection.pair.IMutablePair Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2014-2024 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.collection.pair;

import javax.annotation.Nonnull;

import com.helger.commons.state.EChange;

/**
 * Interface for a writable pair.
 *
 * @author Philip Helger
 * @param 
 *        First type.
 * @param 
 *        Second type.
 */
public interface IMutablePair  extends IPair 
{
  /**
   * Set the first value.
   *
   * @param aFirst
   *        The first value. May be null depending on the
   *        implementation.
   * @return {@link EChange}
   */
  @Nonnull
  EChange setFirst (DATA1TYPE aFirst);

  /**
   * Set the second value.
   *
   * @param aSecond
   *        The second value. May be null depending on the
   *        implementation.
   * @return {@link EChange}
   */
  @Nonnull
  EChange setSecond (DATA2TYPE aSecond);
}