• Home
• com.devonfw.cobigen
• core-api
• 6.0.0
• source code
• TriggerInterpreter.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.devonfw.cobigen.api.extension.TriggerInterpreter Maven / Gradle / Ivy

package com.devonfw.cobigen.api.extension;

import com.devonfw.cobigen.api.annotation.ExceptionFacade;

/**
 * This interface should be inherited by implementations to cover the interpretation of new trigger types.
 * Therefore you have to provide exactly one {@link InputReader} and one {@link MatcherInterpreter}.
 */
@ExceptionFacade
public interface TriggerInterpreter {

    /**
     * This function should return the type name, which could be declared in the type parameter of the XML
     * <trigger> element and therefore invoke this interpreter
     * @return the type name (not null)
     */
    public String getType();

    /**
     * This function should return the {@link InputReader} for reading the intended input format for this
     * trigger interpreter
     * @return the {@link InputReader} (not null)
     */
    public InputReader getInputReader();

    /**
     * This function should return the {@link MatcherInterpreter} for matching a given input as a valid input
     * to be processed and resolving the values of all variable assignments
     * @return the {@link MatcherInterpreter} (not null)
     */
    public MatcherInterpreter getMatcher();
}