Package com.mckoi.store

Interface Area

All Known Subinterfaces:
MutableArea
public interface Area
An interface for access the contents of an area of a store. The area object maintains a pointer that can be manipulated and read from.
Author:
Tobias Downer

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    capacity()
    Returns the capacity of the area.
    void
    copyTo(AreaWriter destination_writer, int size)
    Copies 'size' bytes from the current position of this Area to the destination AreaWriter.
    byte
    get()
     
    void
    get(byte[] buf, int off, int len)
     
    char
    getChar()
     
    long
    getID()
    Returns the unique identifier that represents this area.
    int
    getInt()
     
    long
    getLong()
     
    short
    getShort()
     
    int
    position()
    Returns the current position of the pointer within the area.
    void
    position(int position)
    Sets the position within the area.

  • Method Details

    • getID

      long getID()
      Returns the unique identifier that represents this area.

    • position

      int position()
      Returns the current position of the pointer within the area. The position starts at beginning of the area.

    • capacity

      int capacity()
      Returns the capacity of the area.

    • position

      void position(int position) throws IOException
      Sets the position within the area.
      Throws:
      IOException

    • copyTo

      void copyTo(AreaWriter destination_writer, int size) throws IOException
      Copies 'size' bytes from the current position of this Area to the destination AreaWriter.
      Throws:
      IOException

    • get

      byte get() throws IOException
      Throws:
      IOException

    • get

      void get(byte[] buf, int off, int len) throws IOException
      Throws:
      IOException

    • getShort

      short getShort() throws IOException
      Throws:
      IOException

    • getInt

      int getInt() throws IOException
      Throws:
      IOException

    • getLong

      long getLong() throws IOException
      Throws:
      IOException

    • getChar

      char getChar() throws IOException
      Throws:
      IOException