123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213 |
- /*
- * Copyright (C) 2008-2009, Google Inc.
- * Copyright (C) 2009, Robin Rosenberg <robin.rosenberg@dewire.com>
- * Copyright (C) 2006-2008, Shawn O. Pearce <spearce@spearce.org>
- * and other copyright owners as documented in the project's IP log.
- *
- * This program and the accompanying materials are made available
- * under the terms of the Eclipse Distribution License v1.0 which
- * accompanies this distribution, is reproduced below, and is
- * available at http://www.eclipse.org/org/documents/edl-v10.php
- *
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or
- * without modification, are permitted provided that the following
- * conditions are met:
- *
- * - Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * - Redistributions in binary form must reproduce the above
- * copyright notice, this list of conditions and the following
- * disclaimer in the documentation and/or other materials provided
- * with the distribution.
- *
- * - Neither the name of the Eclipse Foundation, Inc. nor the
- * names of its contributors may be used to endorse or promote
- * products derived from this software without specific prior
- * written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
- package org.eclipse.jgit.util;
-
- import java.io.EOFException;
- import java.io.File;
- import java.io.FileInputStream;
- import java.io.FileNotFoundException;
- import java.io.IOException;
- import java.io.InputStream;
- import java.nio.ByteBuffer;
- import java.text.MessageFormat;
-
- import org.eclipse.jgit.JGitText;
-
- /**
- * Input/Output utilities
- */
- public class IO {
-
- /**
- * Read an entire local file into memory as a byte array.
- *
- * @param path
- * location of the file to read.
- * @return complete contents of the requested local file.
- * @throws FileNotFoundException
- * the file does not exist.
- * @throws IOException
- * the file exists, but its contents cannot be read.
- */
- public static final byte[] readFully(final File path)
- throws FileNotFoundException, IOException {
- return IO.readFully(path, Integer.MAX_VALUE);
- }
-
- /**
- * Read an entire local file into memory as a byte array.
- *
- * @param path
- * location of the file to read.
- * @param max
- * maximum number of bytes to read, if the file is larger than
- * this limit an IOException is thrown.
- * @return complete contents of the requested local file.
- * @throws FileNotFoundException
- * the file does not exist.
- * @throws IOException
- * the file exists, but its contents cannot be read.
- */
- public static final byte[] readFully(final File path, final int max)
- throws FileNotFoundException, IOException {
- final FileInputStream in = new FileInputStream(path);
- try {
- final long sz = in.getChannel().size();
- if (sz > max)
- throw new IOException(MessageFormat.format(
- JGitText.get().fileIsTooLarge, path));
- final byte[] buf = new byte[(int) sz];
- IO.readFully(in, buf, 0, buf.length);
- return buf;
- } finally {
- try {
- in.close();
- } catch (IOException ignored) {
- // ignore any close errors, this was a read only stream
- }
- }
- }
-
- /**
- * Read an entire input stream into memory as a ByteBuffer.
- *
- * Note: The stream is read to its end and is not usable after calling this
- * method. The caller is responsible for closing the stream.
- *
- * @param in
- * input stream to be read.
- * @param sizeHint
- * a hint on the approximate number of bytes contained in the
- * stream, used to allocate temporary buffers more efficiently
- * @return complete contents of the input stream. The ByteBuffer always has
- * a writable backing array, with {@code position() == 0} and
- * {@code limit()} equal to the actual length read. Callers may rely
- * on obtaining the underlying array for efficient data access. If
- * {@code sizeHint} was too large, the array may be over-allocated,
- * resulting in {@code limit() < array().length}.
- * @throws IOException
- * there was an error reading from the stream.
- */
- public static ByteBuffer readWholeStream(InputStream in, int sizeHint)
- throws IOException {
- byte[] out = new byte[sizeHint];
- int pos = 0;
- while (pos < out.length) {
- int read = in.read(out, pos, out.length - pos);
- if (read < 0)
- return ByteBuffer.wrap(out, 0, pos);
- pos += read;
- }
-
- int last = in.read();
- if (last < 0)
- return ByteBuffer.wrap(out, 0, pos);
-
- TemporaryBuffer.Heap tmp = new TemporaryBuffer.Heap(Integer.MAX_VALUE);
- tmp.write(out);
- tmp.write(last);
- tmp.copy(in);
- return ByteBuffer.wrap(tmp.toByteArray());
- }
-
- /**
- * Read the entire byte array into memory, or throw an exception.
- *
- * @param fd
- * input stream to read the data from.
- * @param dst
- * buffer that must be fully populated, [off, off+len).
- * @param off
- * position within the buffer to start writing to.
- * @param len
- * number of bytes that must be read.
- * @throws EOFException
- * the stream ended before dst was fully populated.
- * @throws IOException
- * there was an error reading from the stream.
- */
- public static void readFully(final InputStream fd, final byte[] dst,
- int off, int len) throws IOException {
- while (len > 0) {
- final int r = fd.read(dst, off, len);
- if (r <= 0)
- throw new EOFException(JGitText.get().shortReadOfBlock);
- off += r;
- len -= r;
- }
- }
-
- /**
- * Skip an entire region of an input stream.
- * <p>
- * The input stream's position is moved forward by the number of requested
- * bytes, discarding them from the input. This method does not return until
- * the exact number of bytes requested has been skipped.
- *
- * @param fd
- * the stream to skip bytes from.
- * @param toSkip
- * total number of bytes to be discarded. Must be >= 0.
- * @throws EOFException
- * the stream ended before the requested number of bytes were
- * skipped.
- * @throws IOException
- * there was an error reading from the stream.
- */
- public static void skipFully(final InputStream fd, long toSkip)
- throws IOException {
- while (toSkip > 0) {
- final long r = fd.skip(toSkip);
- if (r <= 0)
- throw new EOFException(JGitText.get().shortSkipOfBlock);
- toSkip -= r;
- }
- }
-
- private IO() {
- // Don't create instances of a static only utility.
- }
- }
|