Module com.io7m.jspiel.vanilla
Package com.io7m.jspiel.vanilla

Class RiffRestrictedSeekableByteChannel

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.ByteChannel, java.nio.channels.Channel, java.nio.channels.ReadableByteChannel, java.nio.channels.SeekableByteChannel, java.nio.channels.WritableByteChannel
    public final class RiffRestrictedSeekableByteChannel
extends java.lang.Object
implements java.nio.channels.SeekableByteChannel
    A byte channel that can only access a specified range of a given underlying channel.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()  
      static java.nio.channels.SeekableByteChannel create​(java.nio.channels.SeekableByteChannel in_channel, long in_lower, long in_upper, boolean in_allow_close)
      Create a new restricted seekable byte channel.
      boolean isOpen()  
      long position()  
      java.nio.channels.SeekableByteChannel position​(long new_position)  
      int read​(java.nio.ByteBuffer dst)  
      long size()  
      java.nio.channels.SeekableByteChannel truncate​(long size)  
      int write​(java.nio.ByteBuffer src)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • create

        public static java.nio.channels.SeekableByteChannel create​(java.nio.channels.SeekableByteChannel in_channel,
                                                           long in_lower,
                                                           long in_upper,
                                                           boolean in_allow_close)
        Create a new restricted seekable byte channel.
        Parameters:
        in_channel - The underlying byte channel
        in_lower - The lower bound of the accessible range
        in_upper - The upper bound of the accessible range
        in_allow_close - true if closing this channel closes the underlying channel
        Returns:
        A new channel

      • read

        public int read​(java.nio.ByteBuffer dst)
         throws java.io.IOException
        Specified by:
        read in interface java.nio.channels.ReadableByteChannel
        Specified by:
        read in interface java.nio.channels.SeekableByteChannel
        Throws:
        java.io.IOException

      • write

        public int write​(java.nio.ByteBuffer src)
          throws java.io.IOException
        Specified by:
        write in interface java.nio.channels.SeekableByteChannel
        Specified by:
        write in interface java.nio.channels.WritableByteChannel
        Throws:
        java.io.IOException

      • position

        public long position()
              throws java.io.IOException
        Specified by:
        position in interface java.nio.channels.SeekableByteChannel
        Throws:
        java.io.IOException

      • position

        public java.nio.channels.SeekableByteChannel position​(long new_position)
                                               throws java.io.IOException
        Specified by:
        position in interface java.nio.channels.SeekableByteChannel
        Throws:
        java.io.IOException

      • size

        public long size()
          throws java.io.IOException
        Specified by:
        size in interface java.nio.channels.SeekableByteChannel
        Throws:
        java.io.IOException

      • truncate

        public java.nio.channels.SeekableByteChannel truncate​(long size)
                                               throws java.io.IOException
        Specified by:
        truncate in interface java.nio.channels.SeekableByteChannel
        Throws:
        java.io.IOException

      • isOpen

        public boolean isOpen()
        Specified by:
        isOpen in interface java.nio.channels.Channel

      • close

        public void close()
           throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.nio.channels.Channel
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException