net.sf.mmm.util.io.api.ByteArrayBuffer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mmm-util-io Show documentation

Utilities for input/output and streaming.

The newest version!

/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package net.sf.mmm.util.io.api;

/**
 * This is the interface for a byte[] buffer. It is similar to {@link java.nio.ByteBuffer} but a lot simpler. However it
 * allows to {@link #setCurrentIndex(int) set the current index} so the internal {@link #getBytes() buffer}-array can be
 * consumed externally and proceeded very fast. 

 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.1.0
 */
public interface ByteArrayBuffer extends ByteArray, ByteBuffer {

  /**
   * This method sets the {@link #getCurrentIndex() currentIndex}. This can be useful e.g. if data from the
   * {@link #getBytes() buffer} has been consumed externally. 

   * ATTENTION:

   * Be very careful and only use this method if you know what you are doing!
   *
   * @param currentIndex is the {@link #getCurrentIndex() currentIndex} to set. It has to be in the range from
   *        {@link #getMinimumIndex() minimumIndex} to {@link #getMaximumIndex() maximumIndex} + 1. A value
   *        of {@link #getMaximumIndex() maximumIndex} + 1 indicates that the buffer is consumed.
   */
  void setCurrentIndex(int currentIndex);

}