com.helger.commons.aggregate.IAggregator 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.8+ Library with tons of utility classes required in all projects

The newest version!

/*
 * 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.commons.aggregate;

import java.util.Collection;
import java.util.function.Function;

import javax.annotation.Nullable;

import com.helger.commons.collection.impl.CommonsArrayList;

/**
 * Aggregate a list of input objects to a single output object (change n to 1).
 *
 * @author Philip Helger
 * @param 
 *        The input type.
 * @param 
 *        The output type.
 */
@FunctionalInterface
public interface IAggregator  extends Function , DSTTYPE>
{
  /**
   * Aggregate a array of input objects to a single output object.
   *
   * @param aObjects
   *        Source object array. May not be null.
   * @return The aggregated object. May be null.
   */
  @Nullable
  @SuppressWarnings ("unchecked")
  // @SafeVarArgs does not work for default methods
  default DSTTYPE apply (@Nullable final SRCTYPE... aObjects)
  {
    return apply (new CommonsArrayList <> (aObjects));
  }
}