com.speedment.common.function.collector.LongCollector Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of generator-deploy Show documentation
Show all versions of generator-deploy Show documentation
A Speedment bundle that shades all dependencies into one jar. This is
useful when deploying an application on a server.
The newest version!
/*
*
* Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
*
* 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.speedment.common.function.collector;
import com.speedment.common.function.internal.collector.LongCollectorImpl;
import java.util.Set;
import java.util.function.BinaryOperator;
import java.util.function.Function;
import java.util.function.ObjLongConsumer;
import java.util.function.Supplier;
import java.util.stream.Collector;
import java.util.stream.Collector.Characteristics;
/**
* Primitive collector that operates on {@code long} values, resulting in an
* object of type {@code R}.
*
* @param the intermediary accumulating type
* @param the result type
*
* @author Emil Forslund
* @since 1.0.5
*/
public interface LongCollector {
/**
* Creates and returns a new instance of this interface that simply holds
* the specified {@code supplier}, {@code accumulator}, {@code combiner},
* {@code finisher} and {@code characteristics}.
*
* @param the type of the intermediary collector object
* @param the type of the result
*
* @param supplier how new intermediary objects are created
* @param accumulator how to add a {@code long} to an intermediary
* @param combiner how to combine two intermediaries into one
* @param finisher how to turn an intermediary into a result
* @param characteristics defining characteristics of this collector
*
* @return the new collector
*/
static LongCollector create(
final Supplier supplier,
final ObjLongConsumer accumulator,
final BinaryOperator combiner,
final Function finisher,
final Set characteristics) {
return new LongCollectorImpl<>(
supplier, accumulator, combiner, finisher, characteristics);
}
/**
* Returns a supplier that can create an intermediary accumulating object.
*
* @return the supplier for the accumulating object
*
* @see Collector#supplier()
*/
Supplier supplier();
/**
* Stateless function that takes an accumulating object returned by{@link
* #supplier()} and adds a single {@code long} value to it.
*
* @return the accumulator
*
* @see Collector#accumulator()
*/
ObjLongConsumer accumulator();
/**
* Stateless function that takes two accumulating objects and returns a
* single one representing the combined result. This can be either one of
* the two instances or a completely new instance.
*
* @return the combiner
*
* @see Collector#combiner()
*/
BinaryOperator combiner();
/**
* Returns a finisher function that takes an accumulating object and turns
* it into the final {@code double}.
*
* @return the finisher
*
* @see Collector#finisher()
*/
Function finisher();
/**
* Returns a set of characteristics for this collector.
*
* @return the characteristics for this collector
*
* @see Collector#characteristics()
*/
Set characteristics();
}