com.github.libgraviton.gdk.generator.GeneratorInstructionLoader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gdk-maven-plugin Show documentation

The newest version!

package com.github.libgraviton.gdk.generator;

import com.github.libgraviton.gdk.exception.CommunicationException;

import java.util.List;

/**
 * Defines generator instruction loaders. These are components capable of providing instructions which can be
 * processed by the generator.
 */
public interface GeneratorInstructionLoader {

    /**
     * Loads all generator instructions. If the instructions are already loaded, a cached instruction set should be
     * returned.
     *
     * @return The instruction set.
     */
    List loadInstructions() throws CommunicationException;

    /**
     * Loads all generator instructions.
     *
     * @param reload If the instructions are already loaded and this addParam is set to false, a cached instruction set
     *               should be returned. Otherwise the instruction list should be (re-) loaded.
     *
     * @return The instruction set.
     */
    List loadInstructions(boolean reload) throws CommunicationException;

}