1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
/* * @(#)IIOByteBuffer.java 1.15 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.imageio.stream; /** * A class representing a mutable reference to an array of bytes and * an offset and length within that array. <code>IIOByteBuffer</code> * is used by <code>ImageInputStream</code> to supply a sequence of bytes * to the caller, possibly with fewer copies than using the conventional * <code>read</code> methods that take a user-supplied byte array. * * <p> The byte array referenced by an <code>IIOByteBuffer</code> will * generally be part of an internal data structure belonging to an * <code>ImageReader</code> implementation; its contents should be * considered read-only and must not be modified. * * @version 0.5 */ public class IIOByteBuffer { private byte[] data; private int offset; private int length; /** * Constructs an <code>IIOByteBuffer</code> that references a * given byte array, offset, and length. * * @param data a byte array. * @param offset an int offset within the array. * @param length an int specifying the length of the data of * interest within byte array, in bytes. */ public IIOByteBuffer(byte[] data, int offset, int length) { this.data = data; this.offset = offset; this.length = length; } /** * Returns a reference to the byte array. The returned value should * be treated as read-only, and only the portion specified by the * values of <code>getOffset</code> and <code>getLength</code> should * be used. * * @return a byte array reference. * * @see #getOffset * @see #getLength * @see #setData */ public byte[] getData() { return data; } /** * Updates the array reference that will be returned by subsequent calls * to the <code>getData</code> method. * * @param data a byte array reference containing the new data value. * * @see #getData */ public void setData(byte[] data) { this.data = data; } /** * Returns the offset within the byte array returned by * <code>getData</code> at which the data of interest start. * * @return an int offset. * * @see #getData * @see #getLength * @see #setOffset */ public int getOffset() { return offset; } /** * Updates the value that will be returned by subsequent calls * to the <code>getOffset</code> method. * * @param offset an int containing the new offset value. * * @see #getOffset */ public void setOffset(int offset) { this.offset = offset; } /** * Returns the length of the data of interest within the byte * array returned by <code>getData</code>. * * @return an int length. * * @see #getData * @see #getOffset * @see #setLength */ public int getLength() { return length; } /** * Updates the value that will be returned by subsequent calls * to the <code>getLength</code> method. * * @param length an int containing the new length value. * * @see #getLength */ public void setLength(int length) { this.length = length; } }