Java Doc for ByteBuffer.java in » Apache-Harmony-Java-SE » java-package » java » nio » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Apache Harmony Java SE » java package » java.nio

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

java.nio .Buffer

java.nio .ByteBuffer

All known Subclasses:   java.nio .MappedByteBuffer,  java.nio .BaseByteBuffer,
ByteBuffer
abstract public class ByteBuffer extends Buffer implements Comparable<ByteBuffer>(Code)
A buffer of bytes.
A byte buffer can be created in either of the following ways:

ByteBuffer.allocate(int) Allocate a new byte array and create a buffer based on it;

ByteBuffer.allocateDirect(int) Allocate a memory block and create a direct buffer based on it;

ByteBuffer.wrap(byte[]) Wrap an existing byte array to create a new buffer.

Field Summary
Endianness order
     The byte order of this buffer, default is BIG_ENDIAN.

Constructor Summary
ByteBuffer(int capacity)
     Constructs a ByteBuffer with given capacity.

Method Summary
public static ByteBuffer allocate(int capacity)
     Creates a byte buffer based on a new allocated byte array.
public static ByteBuffer allocateDirect(int capacity)
     Creates a direct byte buffer based on a new allocated memory block.
final public byte[] array()
     Returns the byte array which this buffer is based on, if there's one.
final public int arrayOffset()
     Returns the offset of the byte array which this buffer is based on, if there's one.
abstract public CharBuffer asCharBuffer()
     Returns a char buffer which is based on the remaining content of this byte buffer.
The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set.
abstract public DoubleBuffer asDoubleBuffer()
     Returns a double buffer which is based on the remaining content of this byte buffer.
The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set.
abstract public FloatBuffer asFloatBuffer()
     Returns a float buffer which is based on the remaining content of this byte buffer.
The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set.
abstract public IntBuffer asIntBuffer()
     Returns a int buffer which is based on the remaining content of this byte buffer.
The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set.
abstract public LongBuffer asLongBuffer()
     Returns a long buffer which is based on the remaining content of this byte buffer.
The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set.
abstract public ByteBuffer asReadOnlyBuffer()
     Returns a readonly buffer that shares content with this buffer.
The returned buffer is guaranteed to be a new instance, even if this buffer is readonly itself.
abstract public ShortBuffer asShortBuffer()
     Returns a short buffer which is based on the remaining content of this byte buffer.
The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set.
abstract public ByteBuffer compact()
     Compacts this byte buffer.
The remaining bytes will be moved to the head of the buffer, staring from position zero.
public int compareTo(ByteBuffer otherBuffer)
     Compare the remaining bytes of this buffer to another byte buffer's remaining bytes.
abstract public ByteBuffer duplicate()
     Returns a duplicated buffer that shares content with this buffer.
The duplicated buffer's position, limit, capacity and mark are the same as this buffer.
public boolean equals(Object other)
     Tests whether this byte buffer equals to another object.
If other is not a byte buffer, then false is returned.

Two byte buffers are equals if, and only if, their remaining bytes are exactly the same.
abstract public byte get()
     Returns the byte at the current position and increase the position by 1.
public ByteBuffer get(byte[] dest)
     Reads bytes from the current position into the specified byte array and increase the position by the number of bytes read.
public ByteBuffer get(byte[] dest, int off, int len)
     Reads bytes from the current position into the specified byte array, starting from the specified offset, and increase the position by the number of bytes read.
abstract public byte get(int index)
     Returns a byte at the specified index, and the position is not changed.
abstract public char getChar()
     Returns the char at the current position and increase the position by 2.
The 2 bytes start from the current position are composed into a char according to current byte order and returned.
abstract public char getChar(int index)
     Returns the char at the specified index.
The 2 bytes start from the specified index are composed into a char according to current byte order and returned.
abstract public double getDouble()
     Returns the double at the current position and increase the position by 8.
The 8 bytes start from the current position are composed into a double according to current byte order and returned.
abstract public double getDouble(int index)
     Returns the double at the specified index.
The 8 bytes start from the specified index are composed into a double according to current byte order and returned.
abstract public float getFloat()
     Returns the float at the current position and increase the position by 4.
The 4 bytes start from the current position are composed into a float according to current byte order and returned.
abstract public float getFloat(int index)
     Returns the float at the specified index.
The 4 bytes start from the specified index are composed into a float according to current byte order and returned.
abstract public int getInt()
     Returns the int at the current position and increase the position by 4.
The 4 bytes start from the current position are composed into a int according to current byte order and returned.
abstract public int getInt(int index)
     Returns the int at the specified index.
The 4 bytes start from the specified index are composed into a int according to current byte order and returned.
abstract public long getLong()
     Returns the long at the current position and increase the position by 8.
The 8 bytes start from the current position are composed into a long according to current byte order and returned.
abstract public long getLong(int index)
     Returns the long at the specified index.
The 8 bytes start from the specified index are composed into a long according to current byte order and returned.
abstract public short getShort()
     Returns the short at the current position and increase the position by 2.
The 2 bytes start from the current position are composed into a short according to current byte order and returned.
abstract public short getShort(int index)
     Returns the short at the specified index.
The 2 bytes start from the specified index are composed into a short according to current byte order and returned.
final public boolean hasArray()
     Returns whether this buffer is based on a byte array and is read/write.
public int hashCode()
     Hash code is calculated from the remaining bytes.
abstract public boolean isDirect()
     Returns true if this buffer is direct.
final public ByteOrder order()
     Returns the byte order used by this buffer when converting bytes from/to other primitive types.
final public ByteBuffer order(ByteOrder byteOrder)
     Sets the byte order of this buffer.
Parameters:
  byteOrder - The byte order to set.
ByteBuffer orderImpl(ByteOrder byteOrder)

abstract byte[] protectedArray()
     Child class implements this method to realize array().
abstract int protectedArrayOffset()
     Child class implements this method to realize arrayOffset().
abstract boolean protectedHasArray()
     Child class implements this method to realize hasArray().
abstract public ByteBuffer put(byte b)
     Writes the given byte to the current position and increase the position by 1.
final public ByteBuffer put(byte[] src)
     Writes bytes in the given byte array to the current position and increase the position by the number of bytes written.
public ByteBuffer put(byte[] src, int off, int len)
     Writes bytes in the given byte array, starting from the specified offset, to the current position and increase the position by the number of bytes written.
public ByteBuffer put(ByteBuffer src)
     Writes all the remaining bytes of the src byte buffer to this buffer's current position, and increase both buffers' position by the number of bytes copied.
abstract public ByteBuffer put(int index, byte b)
     Write a byte to the specified index of this buffer and the position is not changed.
abstract public ByteBuffer putChar(char value)
     Writes the given char to the current position and increase the position by 2.
abstract public ByteBuffer putChar(int index, char value)
     Write a char to the specified index of this buffer.
The char is converted to bytes using the current byte order.
abstract public ByteBuffer putDouble(double value)
     Writes the given double to the current position and increase the position by 8.
abstract public ByteBuffer putDouble(int index, double value)
     Write a double to the specified index of this buffer.
The double is converted to bytes using the current byte order.
abstract public ByteBuffer putFloat(float value)
     Writes the given float to the current position and increase the position by 4.
abstract public ByteBuffer putFloat(int index, float value)
     Write a float to the specified index of this buffer.
The float is converted to bytes using the current byte order.
abstract public ByteBuffer putInt(int value)
     Writes the given int to the current position and increase the position by 4.
abstract public ByteBuffer putInt(int index, int value)
     Write a int to the specified index of this buffer.
The int is converted to bytes using the current byte order.
abstract public ByteBuffer putLong(long value)
     Writes the given long to the current position and increase the position by 8.
abstract public ByteBuffer putLong(int index, long value)
     Write a long to the specified index of this buffer.
The long is converted to bytes using the current byte order.
abstract public ByteBuffer putShort(short value)
     Writes the given short to the current position and increase the position by 2.
abstract public ByteBuffer putShort(int index, short value)
     Write a short to the specified index of this buffer.
The short is converted to bytes using the current byte order.
abstract public ByteBuffer slice()
     Returns a sliced buffer that shares content with this buffer.
The sliced buffer's capacity will be this buffer's remaining(), and its zero position will correspond to this buffer's current position.
public String toString()
     Returns a string represents the state of this byte buffer.
public static ByteBuffer wrap(byte[] array)
     Creates a new byte buffer by wrapping the given byte array.
public static ByteBuffer wrap(byte[] array, int start, int len)
     Creates new a byte buffer by wrapping the given byte array.

Field Detail
order
Endianness order(Code)
The byte order of this buffer, default is BIG_ENDIAN.

Constructor Detail
ByteBuffer
ByteBuffer(int capacity)(Code)
Constructs a ByteBuffer with given capacity.
Parameters:
  capacity - The capacity of the buffer

Method Detail
allocate
public static ByteBuffer allocate(int capacity)(Code)
Creates a byte buffer based on a new allocated byte array.
Parameters:
  capacity - The capacity of the new buffer The created byte buffer
throws:
  IllegalArgumentException - If capacity is less than zero

allocateDirect
public static ByteBuffer allocateDirect(int capacity)(Code)
Creates a direct byte buffer based on a new allocated memory block.
Parameters:
  capacity - The capacity of the new buffer The created byte buffer
throws:
  IllegalArgumentException - If capacity is less than zero

array
final public byte[] array()(Code)
Returns the byte array which this buffer is based on, if there's one. The byte array which this buffer is based on
exception:
  ReadOnlyBufferException - If this buffer is based on a readonly array
exception:
  UnsupportedOperationException - If this buffer is not based on an array

arrayOffset
final public int arrayOffset()(Code)
Returns the offset of the byte array which this buffer is based on, if there's one.
The offset is the index of the array corresponds to the zero position of the buffer.
The offset of the byte array which this buffer is based on
exception:
  ReadOnlyBufferException - If this buffer is based on a readonly array
exception:
  UnsupportedOperationException - If this buffer is not based on an array

asCharBuffer
abstract public CharBuffer asCharBuffer()(Code)
Returns a char buffer which is based on the remaining content of this byte buffer.
The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set. The new buffer's readonly property and byte order are same as this buffer. The new buffer is direct, if this byte buffer is direct.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.
A char buffer which is based on the content of this byte buffer.

asDoubleBuffer
abstract public DoubleBuffer asDoubleBuffer()(Code)
Returns a double buffer which is based on the remaining content of this byte buffer.
The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set. The new buffer's readonly property and byte order are same as this buffer. The new buffer is direct, if this byte buffer is direct.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.
A double buffer which is based on the content of this bytebuffer.

asFloatBuffer
abstract public FloatBuffer asFloatBuffer()(Code)
Returns a float buffer which is based on the remaining content of this byte buffer.
The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set. The new buffer's readonly property and byte order are same as this buffer. The new buffer is direct, if this byte buffer is direct.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.
A float buffer which is based on the content of this byte buffer.

asIntBuffer
abstract public IntBuffer asIntBuffer()(Code)
Returns a int buffer which is based on the remaining content of this byte buffer.
The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set. The new buffer's readonly property and byte order are same as this buffer. The new buffer is direct, if this byte buffer is direct.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.
A int buffer which is based on the content of this byte buffer.

asLongBuffer
abstract public LongBuffer asLongBuffer()(Code)
Returns a long buffer which is based on the remaining content of this byte buffer.
The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set. The new buffer's readonly property and byte order are same as this buffer. The new buffer is direct, if this byte buffer is direct.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.
A long buffer which is based on the content of this byte buffer.

asReadOnlyBuffer
abstract public ByteBuffer asReadOnlyBuffer()(Code)
Returns a readonly buffer that shares content with this buffer.
The returned buffer is guaranteed to be a new instance, even if this buffer is readonly itself. The new buffer's position, limit, capacity and mark are the same as this buffer.

The new buffer shares content with this buffer, which means this buffer's change of content will be visible to the new buffer. The two buffer's position, limit and mark are independent.
A readonly version of this buffer.

asShortBuffer
abstract public ShortBuffer asShortBuffer()(Code)
Returns a short buffer which is based on the remaining content of this byte buffer.
The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set. The new buffer's readonly property and byte order are same as this buffer. The new buffer is direct, if this byte buffer is direct.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.
A short buffer which is based on the content of this byte buffer.

compact
abstract public ByteBuffer compact()(Code)
Compacts this byte buffer.
The remaining bytes will be moved to the head of the buffer, staring from position zero. Then the position is set to remaining(); the limit is set to capacity; the mark is cleared.
This buffer
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

compareTo
public int compareTo(ByteBuffer otherBuffer)(Code)
Compare the remaining bytes of this buffer to another byte buffer's remaining bytes.
Parameters:
  otherBuffer - Another byte buffer a negative value if this is less than other; 0 ifthis equals to other; a positive value if this isgreater than other
exception:
  ClassCastException - If other is not a byte buffer

duplicate
abstract public ByteBuffer duplicate()(Code)
Returns a duplicated buffer that shares content with this buffer.
The duplicated buffer's position, limit, capacity and mark are the same as this buffer. The duplicated buffer's readonly property and byte order are same as this buffer too.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.
A duplicated buffer that shares content with this buffer.

equals
public boolean equals(Object other)(Code)
Tests whether this byte buffer equals to another object.
If other is not a byte buffer, then false is returned.

Two byte buffers are equals if, and only if, their remaining bytes are exactly the same. Position, limit, capacity and mark are not considered.

Parameters:
  other - the object to compare against Whether this byte buffer equals to another object.

get
abstract public byte get()(Code)
Returns the byte at the current position and increase the position by 1. The byte at the current position.
exception:
  BufferUnderflowException - If the position is equal or greater than limit

get
public ByteBuffer get(byte[] dest)(Code)
Reads bytes from the current position into the specified byte array and increase the position by the number of bytes read.
Calling this method has the same effect as get(dest, 0, dest.length).

Parameters:
  dest - The destination byte array This buffer
exception:
  BufferUnderflowException - if dest.length is greater thanremaining()

get
public ByteBuffer get(byte[] dest, int off, int len)(Code)
Reads bytes from the current position into the specified byte array, starting from the specified offset, and increase the position by the number of bytes read.
Parameters:
  dest - The target byte array
Parameters:
  off - The offset of the byte array, must be no less than zero and nogreater than dest.length
Parameters:
  len - The number of bytes to read, must be no lessthan zero and no greater than dest.length - off This buffer
exception:
  IndexOutOfBoundsException - If either off or len isinvalid
exception:
  BufferUnderflowException - If len is greater thanremaining()

get
abstract public byte get(int index)(Code)
Returns a byte at the specified index, and the position is not changed.
Parameters:
  index - The index, must be no less than zero and less than limit A byte at the specified index.
exception:
  IndexOutOfBoundsException - If index is invalid

getChar
abstract public char getChar()(Code)
Returns the char at the current position and increase the position by 2.
The 2 bytes start from the current position are composed into a char according to current byte order and returned. The position increases by 2.
The char at the current position.
exception:
  BufferUnderflowException - If the position is greater than limit - 2

getChar
abstract public char getChar(int index)(Code)
Returns the char at the specified index.
The 2 bytes start from the specified index are composed into a char according to current byte order and returned. The position is not changed.

Parameters:
  index - The index, must be no less than zero and equal or less thanlimit - 2 The char at the specified index.
exception:
  IndexOutOfBoundsException - If index is invalid

getDouble
abstract public double getDouble()(Code)
Returns the double at the current position and increase the position by 8.
The 8 bytes start from the current position are composed into a double according to current byte order and returned. The position increases by 8.
The double at the current position.
exception:
  BufferUnderflowException - If the position is greater than limit - 8

getDouble
abstract public double getDouble(int index)(Code)
Returns the double at the specified index.
The 8 bytes start from the specified index are composed into a double according to current byte order and returned. The position is not changed.

Parameters:
  index - The index, must be no less than zero and equal or less thanlimit - 8 The double at the specified index.
exception:
  IndexOutOfBoundsException - If index is invalid

getFloat
abstract public float getFloat()(Code)
Returns the float at the current position and increase the position by 4.
The 4 bytes start from the current position are composed into a float according to current byte order and returned. The position increases by 4.
The float at the current position.
exception:
  BufferUnderflowException - If the position is greater than limit - 4

getFloat
abstract public float getFloat(int index)(Code)
Returns the float at the specified index.
The 4 bytes start from the specified index are composed into a float according to current byte order and returned. The position is not changed.

Parameters:
  index - The index, must be no less than zero and equal or less thanlimit - 4 The float at the specified index.
exception:
  IndexOutOfBoundsException - If index is invalid

getInt
abstract public int getInt()(Code)
Returns the int at the current position and increase the position by 4.
The 4 bytes start from the current position are composed into a int according to current byte order and returned. The position increases by 4.
The int at the current position.
exception:
  BufferUnderflowException - If the position is greater than limit - 4

getInt
abstract public int getInt(int index)(Code)
Returns the int at the specified index.
The 4 bytes start from the specified index are composed into a int according to current byte order and returned. The position is not changed.

Parameters:
  index - The index, must be no less than zero and equal or less thanlimit - 4 The int at the specified index.
exception:
  IndexOutOfBoundsException - If index is invalid

getLong
abstract public long getLong()(Code)
Returns the long at the current position and increase the position by 8.
The 8 bytes start from the current position are composed into a long according to current byte order and returned. The position increases by 8.
The long at the current position.
exception:
  BufferUnderflowException - If the position is greater than limit - 8

getLong
abstract public long getLong(int index)(Code)
Returns the long at the specified index.
The 8 bytes start from the specified index are composed into a long according to current byte order and returned. The position is not changed.

Parameters:
  index - The index, must be no less than zero and equal or less thanlimit - 8 The long at the specified index.
exception:
  IndexOutOfBoundsException - If index is invalid

getShort
abstract public short getShort()(Code)
Returns the short at the current position and increase the position by 2.
The 2 bytes start from the current position are composed into a short according to current byte order and returned. The position increases by 2.
The short at the current position.
exception:
  BufferUnderflowException - If the position is greater than limit - 2

getShort
abstract public short getShort(int index)(Code)
Returns the short at the specified index.
The 2 bytes start from the specified index are composed into a short according to current byte order and returned. The position is not changed.

Parameters:
  index - The index, must be no less than zero and equal or less thanlimit - 2 The short at the specified index.
exception:
  IndexOutOfBoundsException - If index is invalid

hasArray
final public boolean hasArray()(Code)
Returns whether this buffer is based on a byte array and is read/write.
If this buffer is readonly, then false is returned.
Whether this buffer is based on a byte array and is read/write.

hashCode
public int hashCode()(Code)
Hash code is calculated from the remaining bytes.
Position, limit, capacity and mark don't affect the hash code.
The hash code calculated from the remaining bytes.

isDirect
abstract public boolean isDirect()(Code)
Returns true if this buffer is direct.
A byte buffer is direct, if it is based on a byte buffer and the byte buffer is direct.
True if this buffer is direct.

order
final public ByteOrder order()(Code)
Returns the byte order used by this buffer when converting bytes from/to other primitive types.
The default byte order of byte buffer is always BIG_ENDIAN.
The byte order used by this buffer when convertingbytes from/to other primitive types.

order
final public ByteBuffer order(ByteOrder byteOrder)(Code)
Sets the byte order of this buffer.
Parameters:
  byteOrder - The byte order to set. If null then the orderwill be ByteOrder.LITTLE_ENDIAN LITTLE_ENDIAN. This buffer
See Also:   ByteOrder

orderImpl
ByteBuffer orderImpl(ByteOrder byteOrder)(Code)

protectedArray
abstract byte[] protectedArray()(Code)
Child class implements this method to realize array(). see array()

protectedArrayOffset
abstract int protectedArrayOffset()(Code)
Child class implements this method to realize arrayOffset(). see arrayOffset()

protectedHasArray
abstract boolean protectedHasArray()(Code)
Child class implements this method to realize hasArray(). see hasArray()

put
abstract public ByteBuffer put(byte b)(Code)
Writes the given byte to the current position and increase the position by 1.
Parameters:
  b - The byte to write This buffer
exception:
  BufferOverflowException - If position is equal or greater than limit
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

put
final public ByteBuffer put(byte[] src)(Code)
Writes bytes in the given byte array to the current position and increase the position by the number of bytes written.
Calling this method has the same effect as put(src, 0, src.length).

Parameters:
  src - The source byte array This buffer
exception:
  BufferOverflowException - If remaining() is less thansrc.length
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

put
public ByteBuffer put(byte[] src, int off, int len)(Code)
Writes bytes in the given byte array, starting from the specified offset, to the current position and increase the position by the number of bytes written.
Parameters:
  src - The source byte array
Parameters:
  off - The offset of byte array, must be no less than zero and nogreater than src.length
Parameters:
  len - The number of bytes to write, must be no lessthan zero and no greater than src.length - off This buffer
exception:
  BufferOverflowException - If remaining() is less thanlen
exception:
  IndexOutOfBoundsException - If either off or len isinvalid
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

put
public ByteBuffer put(ByteBuffer src)(Code)
Writes all the remaining bytes of the src byte buffer to this buffer's current position, and increase both buffers' position by the number of bytes copied.
Parameters:
  src - The source byte buffer This buffer
exception:
  BufferOverflowException - If src.remaining() is greater than thisbuffer's remaining()
exception:
  IllegalArgumentException - If src is this buffer
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

put
abstract public ByteBuffer put(int index, byte b)(Code)
Write a byte to the specified index of this buffer and the position is not changed.
Parameters:
  index - The index, must be no less than zero and less than the limit
Parameters:
  b - The byte to write This buffer
exception:
  IndexOutOfBoundsException - If index is invalid
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

putChar
abstract public ByteBuffer putChar(char value)(Code)
Writes the given char to the current position and increase the position by 2.
The char is converted to bytes using the current byte order.

Parameters:
  value - The char to write This buffer
exception:
  BufferOverflowException - If position is greater than limit - 2
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

putChar
abstract public ByteBuffer putChar(int index, char value)(Code)
Write a char to the specified index of this buffer.
The char is converted to bytes using the current byte order. The position is not changed.

Parameters:
  index - The index, must be no less than zero and equal or less thanlimit - 2
Parameters:
  value - The char to write This buffer
exception:
  IndexOutOfBoundsException - If index is invalid
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

putDouble
abstract public ByteBuffer putDouble(double value)(Code)
Writes the given double to the current position and increase the position by 8.
The double is converted to bytes using the current byte order.

Parameters:
  value - The double to write This buffer
exception:
  BufferOverflowException - If position is greater than limit - 8
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

putDouble
abstract public ByteBuffer putDouble(int index, double value)(Code)
Write a double to the specified index of this buffer.
The double is converted to bytes using the current byte order. The position is not changed.

Parameters:
  index - The index, must be no less than zero and equal or less thanlimit - 8
Parameters:
  value - The double to write This buffer
exception:
  IndexOutOfBoundsException - If index is invalid
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

putFloat
abstract public ByteBuffer putFloat(float value)(Code)
Writes the given float to the current position and increase the position by 4.
The float is converted to bytes using the current byte order.

Parameters:
  value - The float to write This buffer
exception:
  BufferOverflowException - If position is greater than limit - 4
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

putFloat
abstract public ByteBuffer putFloat(int index, float value)(Code)
Write a float to the specified index of this buffer.
The float is converted to bytes using the current byte order. The position is not changed.

Parameters:
  index - The index, must be no less than zero and equal or less thanlimit - 4
Parameters:
  value - The float to write This buffer
exception:
  IndexOutOfBoundsException - If index is invalid
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

putInt
abstract public ByteBuffer putInt(int value)(Code)
Writes the given int to the current position and increase the position by 4.
The int is converted to bytes using the current byte order.

Parameters:
  value - The int to write This buffer
exception:
  BufferOverflowException - If position is greater than limit - 4
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

putInt
abstract public ByteBuffer putInt(int index, int value)(Code)
Write a int to the specified index of this buffer.
The int is converted to bytes using the current byte order. The position is not changed.

Parameters:
  index - The index, must be no less than zero and equal or less thanlimit - 4
Parameters:
  value - The int to write This buffer
exception:
  IndexOutOfBoundsException - If index is invalid
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

putLong
abstract public ByteBuffer putLong(long value)(Code)
Writes the given long to the current position and increase the position by 8.
The long is converted to bytes using the current byte order.

Parameters:
  value - The long to write This buffer
exception:
  BufferOverflowException - If position is greater than limit - 8
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

putLong
abstract public ByteBuffer putLong(int index, long value)(Code)
Write a long to the specified index of this buffer.
The long is converted to bytes using the current byte order. The position is not changed.

Parameters:
  index - The index, must be no less than zero and equal or less thanlimit - 8
Parameters:
  value - The long to write This buffer
exception:
  IndexOutOfBoundsException - If index is invalid
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

putShort
abstract public ByteBuffer putShort(short value)(Code)
Writes the given short to the current position and increase the position by 2.
The short is converted to bytes using the current byte order.

Parameters:
  value - The short to write This buffer
exception:
  BufferOverflowException - If position is greater than limit - 2
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

putShort
abstract public ByteBuffer putShort(int index, short value)(Code)
Write a short to the specified index of this buffer.
The short is converted to bytes using the current byte order. The position is not changed.

Parameters:
  index - The index, must be no less than zero and equal or less thanlimit - 2
Parameters:
  value - The short to write This buffer
exception:
  IndexOutOfBoundsException - If index is invalid
exception:
  ReadOnlyBufferException - If no changes may be made to the contents of this buffer

slice
abstract public ByteBuffer slice()(Code)
Returns a sliced buffer that shares content with this buffer.
The sliced buffer's capacity will be this buffer's remaining(), and its zero position will correspond to this buffer's current position. The new buffer's position will be 0, limit will be its capacity, and its mark is unset. The new buffer's readonly property and byte order are same as this buffer.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.
A sliced buffer that shares content with this buffer.

toString
public String toString()(Code)
Returns a string represents the state of this byte buffer. A string represents the state of this byte buffer.

wrap
public static ByteBuffer wrap(byte[] array)(Code)
Creates a new byte buffer by wrapping the given byte array.
Calling this method has the same effect as wrap(array, 0, array.length).

Parameters:
  array - The byte array which the new buffer will be based on The created byte buffer

wrap
public static ByteBuffer wrap(byte[] array, int start, int len)(Code)
Creates new a byte buffer by wrapping the given byte array.
The new buffer's position will be start, limit will be start + len, capacity will be the length of the array.

Parameters:
  array - The byte array which the new buffer will be based on
Parameters:
  start - The start index, must be no less than zero and no greater thanarray.length
Parameters:
  len - The length, must be no less than zero and no greater thanarray.length - start The created byte buffer
exception:
  IndexOutOfBoundsException - If either start or len isinvalid

Fields inherited from java.nio.Buffer
final static int UNSET_MARK(Code)(Java Doc)
final int capacity(Code)(Java Doc)
int limit(Code)(Java Doc)
int mark(Code)(Java Doc)
int position(Code)(Java Doc)

Methods inherited from java.nio.Buffer
final public int capacity()(Code)(Java Doc)
final public Buffer clear()(Code)(Java Doc)
final public Buffer flip()(Code)(Java Doc)
final public boolean hasRemaining()(Code)(Java Doc)
abstract public boolean isReadOnly()(Code)(Java Doc)
final public int limit()(Code)(Java Doc)
final public Buffer limit(int newLimit)(Code)(Java Doc)
final public Buffer mark()(Code)(Java Doc)
final public int position()(Code)(Java Doc)
final public Buffer position(int newPosition)(Code)(Java Doc)
final public int remaining()(Code)(Java Doc)
final public Buffer reset()(Code)(Java Doc)
final public Buffer rewind()(Code)(Java Doc)

Methods inherited from java.lang.Object
protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object object)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final public Class<? extends Object> getClass()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
final public void notify()(Code)(Java Doc)
final public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final public void wait(long millis, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait(long millis) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.