ByteArrayIOEntry (TrueZIP Kernel 7.4.1 API)

java.lang.Object
- de.schlichtherle.truezip.socket.ByteArrayIOEntry

All Implemented Interfaces:

Entry, InputEntry<ByteArrayIOEntry>, IOEntry<ByteArrayIOEntry>, OutputEntry<ByteArrayIOEntry>

Direct Known Subclasses:

ByteArrayIOPool.Entry
```
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
@NotThreadSafe
public class ByteArrayIOEntry
extends Object
implements IOEntry<ByteArrayIOEntry>
```
An I/O entry which uses a byte array.

Author:

Christian Schlichtherle

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`ByteArrayIOEntry.ByteArrayInputSocket`
`private class`	`ByteArrayIOEntry.ByteArrayOutputSocket`
`private class`	`ByteArrayIOEntry.DataInputChannel`
`private class`	`ByteArrayIOEntry.DataInputStream`
`private class`	`ByteArrayIOEntry.DataOutputChannel`
`private class`	`ByteArrayIOEntry.DataOutputStream`
`private class`	`ByteArrayIOEntry.DataReadOnlyFile`
`private class`	`ByteArrayIOEntry.Nio2ByteArrayInputSocket`
`private class`	`ByteArrayIOEntry.Nio2ByteArrayOutputSocket`
`private static class`	`ByteArrayIOEntry.SocketFactory`

Nested classes/interfaces inherited from interface de.schlichtherle.truezip.entry.Entry
Entry.Access, Entry.Size, Entry.Type

Field Summary

Fields
Modifier and Type	Field and Description
`private byte[]`	`data`
`private static ByteArrayIOEntry.SocketFactory`	`FACTORY`
`(package private) int`	`initialCapacity`
`private String`	`name`
`private int`	`reads`
`private EnumMap<Entry.Access,Long>`	`times`
`private int`	`writes`

Fields inherited from interface de.schlichtherle.truezip.entry.Entry
ALL_ACCESS_SET, ALL_SIZE_SET, ALL_TYPE_SET, DIRECTORY_TYPE_SET, FILE_TYPE_SET, SPECIAL_TYPE_SET, SYMLINK_TYPE_SET, UNKNOWN

Constructor Summary

Constructors
Constructor and Description
`ByteArrayIOEntry(String name)` Equivalent to `new ByteArrayIOPool(name, 32)`.
`ByteArrayIOEntry(String name, int initialCapacity)` Constructs a new byte array I/O entry with the given name and initial capacity of the byte array for the next output to this I/O entry.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getCount(Entry.Access type)`
`byte[]`	`getData()` Returns the byte array for input from this I/O entry.
`InputSocket<ByteArrayIOEntry>`	`getInputSocket()` Returns an input socket for reading this entry.
`String`	`getName()` Returns the entry name.
`OutputSocket<ByteArrayIOEntry>`	`getOutputSocket()` Returns an output socket for writing this entry.
`long`	`getSize(Entry.Size type)` Returns the size of the given type for this entry.
`long`	`getTime(Entry.Access type)` Returns the time of the given access type for this entry.
`void`	`setData(byte[] data)` Sets the byte array for input from this I/O entry.
`void`	`setInitialCapacity(int initialCapacity)` Sets the initial capacity of the byte array for the next output to this I/O entry.
`String`	`toString()`

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

- Field Detail
  - data
```
@Nullable
private byte[] data
```
  - FACTORY
```
private static final ByteArrayIOEntry.SocketFactory FACTORY
```
  - initialCapacity
```
int initialCapacity
```
  - name
```
private final String name
```
  - reads
```
private int reads
```
  - times
```
private final EnumMap<Entry.Access,Long> times
```
  - writes
```
private int writes
```
- Constructor Detail
  - ByteArrayIOEntry
```
public ByteArrayIOEntry(String name)
```
    Equivalent to new ByteArrayIOPool(name, 32).
  - ByteArrayIOEntry
```
public ByteArrayIOEntry(String name,
                int initialCapacity)
```
    Constructs a new byte array I/O entry with the given name and initial capacity of the byte array for the next output to this I/O entry.
    
    Parameters:
    name - the name of this entry.
    initialCapacity - the initial capacity of the array to use for the next output to this I/O entry.
- Method Detail
  - getCount
```
public int getCount(Entry.Access type)
```
    Returns:
    The number of times an input or output socket has been used to open a connection to the backing byte array.
  - getData
```
@CheckForNull
public byte[] getData()
```
    Returns the byte array for input from this I/O entry. This usually results from the last output and is initially null. Note that the returned array is not copied, so beware of concurrent modifications!
    
    Returns:
    The byte array for input from this I/O entry.
  - getInputSocket
```
public InputSocket<ByteArrayIOEntry> getInputSocket()
```
    Description copied from interface: InputEntry
    
    Returns an input socket for reading this entry. The method IOSocket.getLocalTarget() of the returned socket must return this entry.
    
    Specified by:
    
    getInputSocket in interface InputEntry<ByteArrayIOEntry>
    
    Returns:
    An input socket for reading this entry.
  - 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 (EntryName.SEPARATOR_CHAR). 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.
    See Also:
    EntryName.create(String)
  - getOutputSocket
```
public OutputSocket<ByteArrayIOEntry> getOutputSocket()
```
    Description copied from interface: OutputEntry
    
    Returns an output socket for writing this entry. The method IOSocket.getLocalTarget() of the returned socket must return this entry.
    
    Specified by:
    
    getOutputSocket in interface OutputEntry<ByteArrayIOEntry>
    
    Returns:
    An output socket for writing this entry.
  - getSize
```
public long getSize(Entry.Size type)
```
    Description copied from interface: Entry
    
    Returns the size of the given type for this entry. 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 to return.
    
    Returns:
    The size of the given size type for this entry in bytes, or Entry.UNKNOWN if not specified or the type is unsupported.
  - getTime
```
public long getTime(Entry.Access type)
```
    Description copied from interface: Entry
    
    Returns the time of the given access type for this entry.
    
    Specified by:
    
    getTime in interface Entry
    
    Parameters:
    type - the type of the access time to return.
    
    Returns:
    The last time an input or output connection to the backing byte array has been closed.
  - setData
```
public void setData(@CheckForNull
           byte[] data)
```
    Sets the byte array for input from this I/O entry. Note that the given array is not copied, so beware of concurrent modifications!
    
    Parameters:
    data - the byte array for input from this I/O entry.
  - setInitialCapacity
```
public final void setInitialCapacity(int initialCapacity)
```
    Sets the initial capacity of the byte array for the next output to this I/O entry.
    
    Parameters:
    initialCapacity - the initial capacity of the array to use for the next output to this I/O entry.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ByteArrayIOEntry

Nested Class Summary

Nested classes/interfaces inherited from interface de.schlichtherle.truezip.entry.Entry

Field Summary

Fields inherited from interface de.schlichtherle.truezip.entry.Entry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

data

FACTORY

initialCapacity

name

reads

times

writes

Constructor Detail

ByteArrayIOEntry

ByteArrayIOEntry

Method Detail

getCount

getData

getInputSocket

getName

getOutputSocket

getSize

getTime

setData

setInitialCapacity

toString