buildSrc/src/main/java/cc/squirreljme/plugin/general/JavaDocFileSupplier.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // Multi-Phasic Applications: SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the GNU General Public License v3+, or later.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.plugin.general;
  11
  12 import java.io.IOException;
  13 import java.io.InputStream;
  14
  15 /**
  16  * Supplier for opening files.
  17  *
  18  * @since 2022/08/29
  19  */
  20 @FunctionalInterface
  21 public interface JavaDocFileSupplier
  22 {
  23         /**
  24          * Opens the given file.
  25          *
  26          * @return The stream to the given file.
  27          * @throws IOException On read errors.
  28          * @since 2022/08/29
  29          */
  30         InputStream open()
  31                 throws IOException;
  32 }