net.sf.mmm.util.io.api.ByteProvider 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 an abstract interface for some object (typically some buffer) that provides bytes. The main impact is to
 * avoid redundant method declarations. It should not be used directly.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.1.0
 */
public abstract interface ByteProvider {

  /**
   * This method gets the number of bytes available.
   *
   * @return the bytes left.
   */
  int getBytesAvailable();

}