/*
 * Copyright 2019, TeamDev. All rights reserved.
 *
 * Redistribution and use in source and/or binary forms, with or without
 * modification, must retain the above copyright notice and the following
 * disclaimer.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package io.spine.tools.validate;

import io.spine.tools.validate.code.Expression;
import io.spine.tools.validate.code.VoidExpression;
import io.spine.validate.ConstraintViolation;

import java.util.function.Function;

/**
 * A function which accepts an expression of a {@link ConstraintViolation} and transforms it into
 * an expression of the violation being saved.
 *
 * <p>Typically, one accumulator is used many times for different violations.
 */
@FunctionalInterface
public interface AccumulateViolations
        extends Function<Expression<ConstraintViolation>, VoidExpression> {
}

@@ -1454,16 +1454,354 @@
 ations.%0A
+ *%0A * %3Cp%3EFor example:%0A * %3Cpre%3E%0A * AccumulateViolation accumulator =%0A *     (violationExpression) -%3E formatted(%22errorBuilder.addViolation(%25s);%22, violationExpression);%0A * %3C/pre%3E%0A *%0A * %3Cp%3EIn the example above a function takes a %7B@link ConstraintViolation%7D expression and uses it%0A * to add the violation to a %7B@code ValidationError%7D builder.%0A
  */%0A@Fun

Add an example for `AccumulateViolations`