java.nio
Class HeapCharBufferR

java.lang.Object
  java.nio.Buffer
      java.nio.CharBuffer
          java.nio.HeapCharBuffer
              java.nio.HeapCharBufferR

All Implemented Interfaces:

CharSequence, Comparable

class HeapCharBufferR

extends HeapCharBuffer

A read-only HeapCharBuffer. This class extends the corresponding read/write class, overriding the mutation methods to throw a ReadOnlyBufferException and overriding the view-buffer methods to return an instance of this class rather than of the superclass.

Field Summary

Fields inherited from class java.nio.CharBuffer

hb, isReadOnly, offset

Fields inherited from class java.nio.Buffer

address

Constructor Summary

(package private)	HeapCharBufferR(char[] buf, int off, int len)
protected	HeapCharBufferR(char[] buf, int mark, int pos, int lim, int cap, int off)
(package private)	HeapCharBufferR(int cap, int lim)

Method Summary

CharBuffer	asReadOnlyBuffer() Creates a new, read-only character buffer that shares this buffer's content.
CharBuffer	compact() Compacts this buffer (optional operation).
CharBuffer	duplicate() Creates a new character buffer that shares this buffer's content.
char	get() Relative get method.
CharBuffer	get(char[] dst, int offset, int length) Relative bulk get method.
char	get(int i) Absolute get method.
boolean	isDirect() Tells whether or not this character buffer is direct.
boolean	isReadOnly() Tells whether or not this buffer is read-only.
protected int	ix(int i)
ByteOrder	order() Retrieves this buffer's byte order.
CharBuffer	put(char x) Relative put method (optional operation).
CharBuffer	put(char[] src, int offset, int length) Relative bulk put method (optional operation).
CharBuffer	put(CharBuffer src) Relative bulk put method (optional operation).
CharBuffer	put(int i, char x) Absolute put method (optional operation).
CharBuffer	slice() Creates a new character buffer whose content is a shared subsequence of this buffer's content.
CharSequence	subSequence(int start, int end) Creates a new character buffer that represents the specified subsequence of this buffer, relative to the current position.
(package private) String	toString(int start, int end)

Methods inherited from class java.nio.CharBuffer

allocate, array, arrayOffset, charAt, compareTo, equals, get, hasArray, hashCode, length, put, put, put, toString, wrap, wrap, wrap, wrap

Methods inherited from class java.nio.Buffer

capacity, checkBounds, checkIndex, checkIndex, clear, flip, hasRemaining, limit, limit, mark, markValue, nextGetIndex, nextGetIndex, nextPutIndex, nextPutIndex, position, position, remaining, reset, rewind

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HeapCharBufferR

HeapCharBufferR(int cap,
                int lim)

HeapCharBufferR

HeapCharBufferR(char[] buf,
                int off,
                int len)

HeapCharBufferR

protected HeapCharBufferR(char[] buf,
                          int mark,
                          int pos,
                          int lim,
                          int cap,
                          int off)

Method Detail

slice

public CharBuffer slice()

Description copied from class: CharBuffer

Creates a new character buffer whose content is a shared subsequence of this buffer's content.

The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's position will be zero, its capacity and its limit will be the number of characters remaining in this buffer, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Overrides:

slice in class HeapCharBuffer

duplicate

public CharBuffer duplicate()

Description copied from class: CharBuffer

Creates a new character buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Overrides:

duplicate in class HeapCharBuffer

asReadOnlyBuffer

public CharBuffer asReadOnlyBuffer()

Description copied from class: CharBuffer

Creates a new, read-only character buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer; the new buffer itself, however, will be read-only and will not allow the shared content to be modified. The two buffers' position, limit, and mark values will be independent.

The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer.

If this buffer is itself read-only then this method behaves in exactly the same way as the duplicate method.

Overrides:

asReadOnlyBuffer in class HeapCharBuffer

isReadOnly

public boolean isReadOnly()

Description copied from class: Buffer

Tells whether or not this buffer is read-only.

Overrides:

isReadOnly in class HeapCharBuffer

put

public CharBuffer put(char x)

Description copied from class: CharBuffer

Relative put method (optional operation).

Writes the given character into this buffer at the current position, and then increments the position.

Overrides:

put in class HeapCharBuffer

put

public CharBuffer put(int i,
                      char x)

Description copied from class: CharBuffer

Absolute put method (optional operation).

Writes the given character into this buffer at the given index.

Overrides:

put in class HeapCharBuffer

put

public CharBuffer put(char[] src,
                      int offset,
                      int length)

Description copied from class: CharBuffer

Relative bulk put method (optional operation).

This method transfers characters into this buffer from the given source array. If there are more characters to be copied from the array than remain in this buffer, that is, if length > remaining(), then no characters are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies length characters from the given array into this buffer, starting at the given offset in the array and at the current position of this buffer. The position of this buffer is then incremented by length.

In other words, an invocation of this method of the form dst.put(src, off, len) has exactly the same effect as the loop

     for (int i = off; i < off + len; i++)
         dst.put(a[i]); 

except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.

Overrides:

put in class HeapCharBuffer

put

public CharBuffer put(CharBuffer src)

Description copied from class: CharBuffer

Relative bulk put method (optional operation).

This method transfers the characters remaining in the given source buffer into this buffer. If there are more characters remaining in the source buffer than in this buffer, that is, if src.remaining() > remaining(), then no characters are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies n = src.remaining() characters from the given buffer into this buffer, starting at each buffer's current position. The positions of both buffers are then incremented by n.

In other words, an invocation of this method of the form dst.put(src) has exactly the same effect as the loop

     while (src.hasRemaining())
         dst.put(src.get()); 

except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.

Overrides:

put in class HeapCharBuffer

compact

public CharBuffer compact()

Description copied from class: CharBuffer

Compacts this buffer (optional operation).

The characters between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the character at index p = position() is copied to index zero, the character at index p + 1 is copied to index one, and so forth until the character at index limit() - 1 is copied to index n = limit() - 1 - p. The buffer's position is then set to n+1 and its limit is set to its capacity. The mark, if defined, is discarded.

The buffer's position is set to the number of characters copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method.

Overrides:

compact in class HeapCharBuffer

toString

String toString(int start,
                int end)

Overrides:

toString in class HeapCharBuffer

subSequence

public CharSequence subSequence(int start,
                                int end)

Description copied from class: CharBuffer

Creates a new character buffer that represents the specified subsequence of this buffer, relative to the current position.

The new buffer will share this buffer's content; that is, if the content of this buffer is mutable then modifications to one buffer will cause the other to be modified. The new buffer's capacity will be that of this buffer, its position will be position() + start, and its limit will be position() + end. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Specified by:

subSequence in interface CharSequence

Overrides:

subSequence in class HeapCharBuffer

order

public ByteOrder order()

Description copied from class: CharBuffer

Retrieves this buffer's byte order.

The byte order of a character buffer created by allocation or by wrapping an existing char array is the native order of the underlying hardware. The byte order of a character buffer created as a view of a byte buffer is that of the byte buffer at the moment that the view is created.

Overrides:

order in class HeapCharBuffer

ix

protected int ix(int i)

get

public char get()

Description copied from class: CharBuffer

Relative get method. Reads the character at this buffer's current position, and then increments the position.

Specified by:

get in class CharBuffer

Returns:

The character at the buffer's current position

get

public char get(int i)

Description copied from class: CharBuffer

Absolute get method. Reads the character at the given index.

Specified by:

get in class CharBuffer

Parameters:

i - The index from which the character will be read

Returns:

The character at the given index

get

public CharBuffer get(char[] dst,
                      int offset,
                      int length)

Description copied from class: CharBuffer

Relative bulk get method.

This method transfers characters from this buffer into the given destination array. If there are fewer characters remaining in the buffer than are required to satisfy the request, that is, if length > remaining(), then no characters are transferred and a BufferUnderflowException is thrown.

Otherwise, this method copies length characters from this buffer into the given array, starting at the current position of this buffer and at the given offset in the array. The position of this buffer is then incremented by length.

In other words, an invocation of this method of the form src.get(dst, off, len) has exactly the same effect as the loop

     for (int i = off; i < off + len; i++)
         dst[i] = src.get(); 

except that it first checks that there are sufficient characters in this buffer and it is potentially much more efficient.

Overrides:

get in class CharBuffer

Parameters:

dst - The array into which characters are to be written

offset - The offset within the array of the first character to be written; must be non-negative and no larger than dst.length

length - The maximum number of characters to be written to the given array; must be non-negative and no larger than dst.length - offset

Returns:

This buffer

isDirect

public boolean isDirect()

Description copied from class: CharBuffer

Tells whether or not this character buffer is direct.

Specified by:

isDirect in class CharBuffer

Returns:

true if, and only if, this buffer is direct