org.cactoos.scalar.SumOfLongScalar Maven / Gradle / Ivy
Show all versions of cactoos Show documentation
/*
* The MIT License (MIT)
*
* Copyright (c) 2017-2018 Yegor Bugayenko
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.cactoos.scalar;
import org.cactoos.Scalar;
/**
* Long Scalar which sums up the values of other Scalars of the same type
*
* Here is how you can use it to summarize numbers:
*
*
* long sum = new SumOfLongScalar(() -> 1,() -> 2, () -> 3).value();
*
*
* This class implements {@link Scalar}, which throws a checked
* {@link Exception}. This may not be convenient in many cases. To make
* it more convenient and get rid of the checked exception you can
* use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.
*
* There is no thread-safety guarantee.
*
* @since 0.30
*/
public final class SumOfLongScalar implements Scalar {
/**
* Varargs of Scalar to sum up values from.
*/
private final Scalar[] scalars;
/**
* Ctor.
* @param src Varargs of Scalar to sum up values from
* @since 0.30
*/
@SafeVarargs
public SumOfLongScalar(final Scalar... src) {
this.scalars = src;
}
@Override
public Long value() {
return new SumOfScalar(this.scalars).value().longValue();
}
}