de.learnlib.api.StateLocalInputSUL Maven / Gradle / Ivy

Go to download

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

Infrastructure and core interfaces of LearnLib

There is a newer version: 0.17.0

/* Copyright (C) 2013-2020 TU Dortmund
 * This file is part of LearnLib, http://www.learnlib.de/.
 *
 * 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 de.learnlib.api;

import java.util.Collection;

import de.learnlib.api.exception.SULException;

/**
 * A System Under Learning (SUL) which can additionally report the inputs that the SUL can process in its current state,
 * i.e. inputs that will not trigger a {@link SULException} when used in the next invocation of the {@link
 * #step(Object)} method return an otherwise "undefined" behavior.
 *
 * @param 
 *         input symbol type
 * @param 
 *         output symbol type
 *
 * @author Maren Geske
 * @author frohme
 */
public interface StateLocalInputSUL extends SUL {

    /**
     * Returns the enabled symbols for the current state of the {@link SUL}.
     *
     * @return the currently enabled inputs
     *
     * @throws SULException
     *         if the {@link SUL} cannot provide information about the currently enabled inputs
     */
    Collection currentlyEnabledInputs();

    @Override
    default StateLocalInputSUL fork() {
        throw new UnsupportedOperationException();
    }
}