/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.tinkerpop.gremlin.process.traversal.step;
/**
* A {@code Generating} step is one that has a side-effect that needs post-processing prior to being returned.
*
* @author Marko A. Rodriguez (http://markorodriguez.com)
*/
public interface Generating<S, E> {
/**
* Post-process the side-effect and return the post-processed side-effect.
* The default implementation is simply the identity function and returns the argument.
*
* @param preCap the pre-processed side-effect.
* @return the post-processed side-effect.
*/
public default E generateFinalResult(final S preCap) {
return (E) preCap;
}
}