nl.uu.cs.ape.models.sltlxStruc.SLTLxParsingAnnotationException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of APE Show documentation

APE is a command line tool and an API for the automated exploration of possible computational pipelines (workflows) from large collections of computational tools.

The newest version!

package nl.uu.cs.ape.models.sltlxStruc;

/**
 * The {@code SLTLxParsingAnnotationException} exception will be thrown if the
 * variables are free or domain predicates (e.g., operations, data types, etc.)
 * specified in the SLTLx formula are not specified correctly.
 * 
 * @author Vedran Kasalica
 *
 */
public class SLTLxParsingAnnotationException extends RuntimeException {

    /**
     * Instantiates a new Ape exception.
     *
     * @param message The message that will be passed to the {@link Exception} super
     *                class.
     */
    private SLTLxParsingAnnotationException(String message) {
        super(message);
    }

    /**
     * Exception is thrown when the specified SLTLx formula contains a type not
     * specified in the type taxonomy.
     * 
     * @param message - Application specific message that may help the user solve
     *                the problem.
     * @return SLTLx Parsing exception with information that may help the user solve
     *         the problem.
     */
    public static SLTLxParsingAnnotationException typeDoesNoExists(String message) {
        return new SLTLxParsingAnnotationException(String.format(
                "SLTLx formula syntax error. One or more data types used in a specified formula cannot be recognised. %s",
                message));
    }

    /**
     * Exception is thrown when the specified SLTLx formula contains a module not
     * specified in the type taxonomy.
     * 
     * @param message - Application specific message that may help the user solve
     *                the problem.
     * @return SLTLx Parsing exception with information that may help the user solve
     *         the problem.
     */
    public static SLTLxParsingAnnotationException moduleDoesNoExists(String message) {
        return new SLTLxParsingAnnotationException(String.format(
                "SLTLx formula syntax error. One or more operations used in a specified formula cannot be recognised. %s",
                message));
    }

    /**
     * Exception is thrown when the specified SLTLx formula contains a free
     * variable.
     * 
     * @param message - Application specific message that may help the user solve
     *                the problem.
     * @return SLTLx Parsing exception with information that may help the user solve
     *         the problem.
     */
    public static SLTLxParsingAnnotationException variableNotBound(String message) {
        return new SLTLxParsingAnnotationException(String.format(
                "SLTLx formula syntax error. A specified formula contains a free variable, which is not supported. %s",
                message));
    }
}