com.anrisoftware.resources.binary.api.BinaryResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of resources-binary Show documentation

Contains the modules of the project.

There is a newer version: 4.7.0

/*
 * Copyright 2012-2014 Erwin Müller 
 *
 * This file is part of resources-binary.
 *
 * resources-binary is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * resources-binary is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with resources-binary. If not, see .
 */
package com.anrisoftware.resources.binary.api;

import java.io.InputStream;

import com.anrisoftware.resources.api.Resource;
import com.anrisoftware.resources.api.ResourcesException;

/**
 * Resource for binary data.
 * 
 * @author Erwin Mueller, [email protected]
 * @since 1.1
 */
public interface BinaryResource extends Resource {

	/**
	 * Returns the binary data of the resource.
	 * 
	 * The binary data is read in to memory upon the first request. It is stored
	 * then for quicker access.
	 * 
	 * @return a byte array of the data.
	 * 
	 * @throws ResourcesException
	 *             if there was an error loading the binary data.
	 */
	byte[] getBinary() throws ResourcesException;

	/**
	 * Opens an input stream that reads the binary data.
	 * 

	 * The binary data can't be stored for quick access because it is red
	 * sequential from the stream.
	 * 
	 * @return an {@link InputStream} that reads the binary data.
	 * 
	 * @throws ResourcesException
	 *             if there was an error opening the binary data.
	 */
	InputStream getStream() throws ResourcesException;

	/**
	 * Discards the binary data of this resource.
	 * 
	 * Use this method if the binary data is no longer needed.
	 * 
	 * @throws ResourcesException
	 *             if there was an error discarding the data.
	 */
	void discardBinary() throws ResourcesException;
}