buildSrc/src/main/java/cc/squirreljme/plugin/multivm/VMLibraryExecuteFunction.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the Mozilla Public License Version 2.0.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.plugin.multivm;
  11
  12 import java.io.IOException;
  13 import java.io.InputStream;
  14 import java.io.OutputStream;
  15 import org.gradle.api.Task;
  16
  17 /**
  18  * Base interface for the execution of library based functions.
  19  *
  20  * @since 2021/05/16
  21  */
  22 @FunctionalInterface
  23 public interface VMLibraryExecuteFunction
  24 {
  25         /**
  26          * Performs the function as required.
  27          *
  28          * @param __task The task used.
  29          * @param __isTest Is this a test?
  30          * @param __in The input stream.
  31          * @param __out The output stream.
  32          * @throws IOException Any read/write errors.
  33          * @since 2021/05/16
  34          */
  35         void function(VMBaseTask __task, boolean __isTest, InputStream __in,
  36                 OutputStream __out)
  37                 throws IOException;
  38 }