org.pragmaticminds.crunch.api.events.GenericEventHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of crunch-api Show documentation

Programing Interfaces for other CRUNCH Projects.

The newest version!

/*
 * 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.pragmaticminds.crunch.api.events;

import org.pragmaticminds.crunch.api.EvalFunction;
import org.pragmaticminds.crunch.events.GenericEvent;
import org.pragmaticminds.crunch.events.GenericEventBuilder;

/**
 * This class handles results of {@link EvalFunction}s. It creates {@link GenericEvent}
 *
 * @author Erwin Wagasow
 * Created by Erwin Wagasow on 20.11.2017
 */
@FunctionalInterface // <- so it can be implemented as lambda
public interface GenericEventHandler {
    /**
     * Is called when a new {@link GenericEvent} is fired inside the {@link EvalFunction}
     *
     * @param event that was fired by a {@link EvalFunction}
     */
    void fire(GenericEvent event);

    /**
     * Returns the {@link GenericEventBuilder}
     *
     * @return
     */
    default GenericEventBuilder getBuilder() {
        return GenericEventBuilder.anEvent();
    }
}