MemoryBuffer (TrueCommons 2.5.0 API)

java.lang.Object
- net.java.truecommons.cio.MemoryBuffer

All Implemented Interfaces:

Entry, IoBuffer, IoEntry<IoBuffer>, Releasable<IOException>
```
@NotThreadSafe
public class MemoryBuffer
extends Object
implements IoBuffer
```
An I/O buffer which shares its contents with a byte buffer.
If the reference to the backing buffer is null, then any attempt to start input from this I/O buffer results in a FileNotFoundException. The reference gets automatically set upon each call to close() on any OutputStream or SeekableByteChannel which has been obtained from an output socket for this I/O buffer. The reference can also get explicitly set by calling the constructor MemoryBuffer(String, ByteBuffer) or the method setBuffer(ByteBuffer).

Author:

Christian Schlichtherle

Nested Class Summary
- Nested classes/interfaces inherited from interface net.java.truecommons.cio.Entry
  Entry.Access, Entry.Entity, Entry.PosixEntity, Entry.Size, Entry.Type

Field Summary
- Fields inherited from interface net.java.truecommons.cio.Entry
  ALL_ACCESS, ALL_POSIX_ACCESS, ALL_POSIX_ENTITIES, ALL_SIZES, ALL_TYPES, DIRECTORY_TYPE, FILE_TYPE, NO_ACCESS, NO_POSIX_ENTITIES, NO_SIZES, NO_TYPES, SPECIAL_TYPE, SYMLINK_TYPE, UNKNOWN

Constructor Summary

Constructors
Constructor and Description
`MemoryBuffer(String name, ByteBuffer buffer)` Constructs a new memory buffer.
`MemoryBuffer(String name, int initialCapacity)` Constructs a new memory buffer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteBuffer`	`getBuffer()` Returns a duplicate of the nullable backing buffer with the contents to share with this memory buffer.
`int`	`getCount(Entry.Access type)`
`int`	`getInitialCapacity()` Returns the initial capacity of the next backing buffer to allocate when starting output to this memory buffer.
`String`	`getName()` Returns the entry name.
`long`	`getSize(Entry.Size type)` Returns the size of the given `type` for this entry in bytes or `Entry.UNKNOWN` if not defined or the type is not supported.
`long`	`getTime(Entry.Access type)` Returns the time of the given access `type` for this entry in milliseconds since the epoch or -1 if not defined or the type is not supported.
`InputSocket<MemoryBuffer>`	`input()` Returns an input socket for reading this entry.
`Boolean`	`isPermitted(Entry.Access type, Entry.Entity entity)` Returns `true` or `false` if the given access `type` to this entry for the given `entity` is respectively permitted or denied.
`OutputSocket<MemoryBuffer>`	`output()` Returns an output socket for writing this entry.
`void`	`release()` Releases this resource to its pool.
`void`	`setBuffer(ByteBuffer buffer)` Sets the nullable backing buffer with the contents to share with this memory buffer.
`void`	`setInitialCapacity(int initialCapacity)` Sets the initial capacity of the next backing buffer to allocate when starting output to this memory buffer.
`String`	`toString()` Returns a string representation of this object for debugging and logging purposes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MemoryBuffer
```
public MemoryBuffer(String name,
                    ByteBuffer buffer)
```
    Constructs a new memory buffer. The initial capacity is set to the capacity of the given backing buffer.
    
    Parameters:
    
    name - the name of this memory buffer.
    
    buffer - the byte buffer with the contents to share with this memory buffer.
  - MemoryBuffer
```
public MemoryBuffer(String name,
                    int initialCapacity)
```
    Constructs a new memory buffer. The reference to the backing buffer is set to null.
    
    Parameters:
    
    name - the name of this memory buffer.
    
    initialCapacity - the initial capacity of the next backing buffer to allocate when starting output to this memory buffer.
- Method Detail
  - getBuffer
```
@Nullable
public final ByteBuffer getBuffer()
```
    Returns a duplicate of the nullable backing buffer with the contents to share with this memory buffer. If the backing buffer is not set, then null is returned. Otherwise, the returned buffer's position is set to zero and its limit is set to the size of the contents of this memory buffer.
    
    Returns:
    
    A duplicate of the nullable backing buffer with the contents to share with this memory buffer.
  - getCount
```
public final int getCount(Entry.Access type)
```
    Parameters:
    
    type - the access type.
    
    Returns:
    
    The number of times an input or output connection to the backing buffer has been opened.
  - getInitialCapacity
```
public final int getInitialCapacity()
```
    Returns the initial capacity of the next backing buffer to allocate when starting output to this memory buffer.
    
    Returns:
    
    The initial capacity of the next backing buffer to allocate when starting output to this memory buffer.
  - getName
```
public final String getName()
```
    Description copied from interface: Entry
    Returns the entry name. When parsed, an entry name is interpreted as follows:
    1. An entry name is a sequence of segments which are separated by one or more separator characters, which may be '/' or '\\' or both, according to the rules of the Container. This implies that a segment cannot contain separator characters.
    2. An entry name may contain one or more dot (".") or dot-dot ("..") segments which represent the current or parent segment respectively.
    3. An entry name may start with one or more separator characters. In this case, its said to be absolute. Otherwise, its said to be relative.
    4. An entry name may end with one or more separator characters (e.g. to identify a directory entry).
    For example, the entry names "foo/bar/" and "./abc/../foo/./def/./../bar/." both refer to the same entry when being parsed.
    Specified by:
    
    getName in interface Entry
    
    Returns:
    
    The entry name.
  - getSize
```
public final long getSize(Entry.Size type)
```
    Description copied from interface: Entry
    
    Returns the size of the given type for this entry in bytes or Entry.UNKNOWN if not defined or the type is not supported. This method may not be meaningful for non-Entry.Type.FILE entries.
    
    Specified by:
    
    getSize in interface Entry
    
    Parameters:
    
    type - the type of the size.
    
    Returns:
    
    The size of the given type for this entry in bytes or Entry.UNKNOWN if not defined or the type is not supported.
  - getTime
```
public final long getTime(Entry.Access type)
```
    Description copied from interface: Entry
    
    Returns the time of the given access type for this entry in milliseconds since the epoch or -1 if not defined or the type is not supported.
    
    Specified by:
    
    getTime in interface Entry
    
    Parameters:
    
    type - the type of the access.
    
    Returns:
    
    The last time an input or output connection to the backing buffer has been close()d.
  - input
```
public final InputSocket<MemoryBuffer> input()
```
    Description copied from interface: IoEntry
    
    Returns an input socket for reading this entry. The method IoSocket.target() of the returned socket must return this entry.
    
    Specified by:
    
    input in interface IoEntry<IoBuffer>
    
    Returns:
    
    An input socket for reading this entry.
  - isPermitted
```
public Boolean isPermitted(Entry.Access type,
                           Entry.Entity entity)
```
    Description copied from interface: Entry
    
    Returns true or false if the given access type to this entry for the given entity is respectively permitted or denied. Returns null if not defined or the access type or entity is not supported.
    
    Specified by:
    
    isPermitted in interface Entry
    
    Parameters:
    
    type - the type of the access.
    
    entity - the entity which desires access.
    
    Returns:
    
    true if and only if the given access type to this entry is permitted for the given entity.
  - output
```
public final OutputSocket<MemoryBuffer> output()
```
    Description copied from interface: IoEntry
    
    Returns an output socket for writing this entry. The method IoSocket.target() of the returned socket must return this entry.
    
    Specified by:
    
    output in interface IoEntry<IoBuffer>
    
    Returns:
    
    An output socket for writing this entry.
  - release
```
public void release()
             throws IOException
```
    Description copied from interface: Releasable
    
    Releases this resource to its pool.
    
    Specified by:
    
    release in interface Releasable<IOException>
    
    Throws:
    
    IOException
  - setBuffer
```
public final void setBuffer(@Nullable
                            ByteBuffer buffer)
```
    Sets the nullable backing buffer with the contents to share with this memory buffer. If buffer is not null, a duplicate is made and rewind in order to protect this memory buffer from concurrent modifications of the given buffer's properties.
    
    Parameters:
    
    buffer - the nullable byte buffer with the contents to share with this memory buffer.
  - setInitialCapacity
```
public final void setInitialCapacity(int initialCapacity)
```
    Sets the initial capacity of the next backing buffer to allocate when starting output to this memory buffer.
    
    Parameters:
    
    initialCapacity - the initial capacity of the next backing buffer to allocate when starting output to this memory buffer.
  - toString
```
public String toString()
```
    Returns a string representation of this object for debugging and logging purposes.
    
    Overrides:
    
    toString in class Object

Class MemoryBuffer

Nested Class Summary

Nested classes/interfaces inherited from interface net.java.truecommons.cio.Entry

Field Summary

Fields inherited from interface net.java.truecommons.cio.Entry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MemoryBuffer

MemoryBuffer

Method Detail

getBuffer

getCount

getInitialCapacity

getName

getSize

getTime

input

isPermitted

output

release

setBuffer

setInitialCapacity

toString