io.engineblock.activityapi.planning.OpSequence Maven / Gradle / Ivy

Go to download

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

The driver API for engineblock; Provides the interfaces needed to build drivers that can be loaded by engineblock core

There is a newer version: 2.12.65

/*
 *
 *    Copyright 2016 jshook
 *    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 io.engineblock.activityapi.planning;

import java.util.List;
import java.util.function.Function;

/**
 * An OpSequence provides fast access to a set of operations in a specific
 * order.
 * @param  The type of element which is to be sequenced
 */
public interface OpSequence {

    /**
     * Get the next operation for the given long value. This is simply
     * the offset indicated by the offset sequence array at a modulo
     * position.
     *
     * @param selector the long value that determines the next op
     * @return An op of type T
     */
    T get(long selector);

    /**
     * Get the list of individual operations which could be returned by {@link #get(long)}.
     * @return A {@link List} of T
     */
    List getOps();

    /**
     * Get the integer sequence that is used to index into the operations.
     * @return an offset pointer array in int[] form
     */
    int[] getSequence();

    /**
     * Map this OpSequence to another type of OpSequence.
     * @param func The transformation function from this to another type
     * @param  The target type of the transformation.
     * @return A new OpSequence of type U
     */
     OpSequence transform(Function func);
}