buildSrc/src/main/java/cc/squirreljme/plugin/util/GuardedOutputStream.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 GNU General Public License v3+, or later.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.plugin.util;
  11
  12 import java.io.IOException;
  13 import java.io.OutputStream;
  14
  15 /**
  16  * This is an output stream that is guarded by being closed.
  17  *
  18  * @since 2020/11/21
  19  */
  20 public final class GuardedOutputStream
  21         extends OutputStream
  22 {
  23         /** The true output stream. */
  24         protected final OutputStream out;
  25
  26         /** Is this closed? */
  27         volatile boolean _closed;
  28
  29         /**
  30          * Initializes the guarded stream.
  31          *
  32          * @param __out The output stream.
  33          * @throws NullPointerException On null arguments.
  34          * @since 2020/11/21
  35          */
  36         public GuardedOutputStream(OutputStream __out)
  37                 throws NullPointerException
  38         {
  39                 if (__out == null)
  40                         throw new NullPointerException("NARG");
  41
  42                 this.out = __out;
  43         }
  44
  45         /**
  46          * {@inheritDoc}
  47          * @since 2020/11/21
  48          */
  49         @Override
  50         public void close()
  51                 throws IOException
  52         {
  53                 if (!this._closed)
  54                 {
  55                         // Make sure everything is written before closing
  56                         try
  57                         {
  58                                 this.out.flush();
  59                         }
  60                         finally
  61                         {
  62                                 this._closed = true;
  63                         }
  64                 }
  65         }
  66
  67         /**
  68          * {@inheritDoc}
  69          * @since 2020/11/21
  70          */
  71         @Override
  72         public void flush()
  73                 throws IOException
  74         {
  75                 if (this._closed)
  76                         throw new IOException("Stream is closed.");
  77
  78                 this.out.flush();
  79         }
  80
  81         /**
  82          * {@inheritDoc}
  83          * @since 2020/11/21
  84          */
  85         @Override
  86         public void write(int __b)
  87                 throws IOException
  88         {
  89                 if (this._closed)
  90                         throw new IOException("Stream is closed.");
  91
  92                 this.out.write(__b);
  93         }
  94
  95         /**
  96          * {@inheritDoc}
  97          * @since 2020/11/21
  98          */
  99         @Override
 100         public void write(byte[] __b)
 101                 throws IOException
 102         {
 103                 if (this._closed)
 104                         throw new IOException("Stream is closed.");
 105
 106                 this.out.write(__b);
 107         }
 108
 109         /**
 110          * {@inheritDoc}
 111          * @since 2020/11/21
 112          */
 113         @Override
 114         public void write(byte[] __b, int __o, int __l)
 115                 throws IOException
 116         {
 117                 if (this._closed)
 118                         throw new IOException("Stream is closed.");
 119
 120                 this.out.write(__b, __o, __l);
 121         }
 122 }