< prev index next >
src/java.desktop/share/classes/javax/imageio/stream/IIOByteBuffer.java
Print this page
*** 25,42 ****
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.
*
*/
public class IIOByteBuffer {
--- 25,42 ----
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}
! * is used by {@code ImageInputStream} to supply a sequence of bytes
* to the caller, possibly with fewer copies than using the conventional
! * {@code read} methods that take a user-supplied byte array.
*
! * <p> The byte array referenced by an {@code IIOByteBuffer} will
* generally be part of an internal data structure belonging to an
! * {@code ImageReader} implementation; its contents should be
* considered read-only and must not be modified.
*
*/
public class IIOByteBuffer {
*** 45,55 ****
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
--- 45,55 ----
private int offset;
private int length;
/**
! * Constructs an {@code IIOByteBuffer} 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
*** 62,72 ****
}
/**
* 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
--- 62,72 ----
}
/**
* 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} and {@code getLength} should
* be used.
*
* @return a byte array reference.
*
* @see #getOffset
*** 77,87 ****
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
*/
--- 77,87 ----
return data;
}
/**
* Updates the array reference that will be returned by subsequent calls
! * to the {@code getData} method.
*
* @param data a byte array reference containing the new data value.
*
* @see #getData
*/
*** 89,99 ****
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
--- 89,99 ----
this.data = data;
}
/**
* Returns the offset within the byte array returned by
! * {@code getData} at which the data of interest start.
*
* @return an int offset.
*
* @see #getData
* @see #getLength
*** 103,113 ****
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
*/
--- 103,113 ----
return offset;
}
/**
* Updates the value that will be returned by subsequent calls
! * to the {@code getOffset} method.
*
* @param offset an int containing the new offset value.
*
* @see #getOffset
*/
*** 115,125 ****
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
--- 115,125 ----
this.offset = offset;
}
/**
* Returns the length of the data of interest within the byte
! * array returned by {@code getData}.
*
* @return an int length.
*
* @see #getData
* @see #getOffset
*** 129,139 ****
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
*/
--- 129,139 ----
return length;
}
/**
* Updates the value that will be returned by subsequent calls
! * to the {@code getLength} method.
*
* @param length an int containing the new length value.
*
* @see #getLength
*/
< prev index next >