InputByteStream (The Adobe Experience Manager SDK 2020.7.3902.20200716T022312Z-200604)

All Known Implementing Classes:

CroppedImageInputByteStream, InputByteStreamImpl, PaddedInputByteStream, RangeInputByteStream
```
public interface InputByteStream
```

Field Summary

Fields
Modifier and Type Field and Description

static int EOF
Only for internal engineering use.

Fields
Modifier and Type	Field and Description
`static int`	`EOF` Only for internal engineering use.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`bytesAvailable()` Only for internal engineering use.
`void`	`close()` Closes this InputByteStream and releases any system resources associated with the stream.
`boolean`	`eof()` Only for internal engineering use.
`long`	`getPosition()` Only for internal engineering use.
`long`	`length()` Only for internal engineering use.
`int`	`read()` Only for internal engineering use.
`int`	`read(byte[] bytes)` Only for internal engineering use.
`int`	`read(byte[] bytes, int position, int length)` Only for internal engineering use.
`InputByteStream`	`seek(long position)` Only for internal engineering use.
`InputByteStream`	`slice()` Only for internal engineering use.
`InputByteStream`	`slice(long begin, long length)` Only for internal engineering use.
`InputStream`	`toInputStream()` Create an InputStream that represents the same data as this InputByteStream.
`int`	`unget()` Only for internal engineering use.

- Field Detail
  - EOF
```
static final int EOF
```
    Only for internal engineering use. This api can change without notice. The value is returned as a marker for the End Of File from the get() methods.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - slice
```
InputByteStream slice(long begin,
                      long length)
               throws IOException
```
    Only for internal engineering use. This api can change without notice. Create a new InputByteStream that that provides another view on the underlying data. This new InputByteStream is completely independent and can be read from and positioned without affecting the original or any other slice InputByteStream objects. The initial position of the slice is at zero - the beginning of the slice.
    
    Parameters:
    
    begin - Offset within the current InputByteStream to start the slice.
    
    length - The length of the slice.
    
    Returns:
    
    A slice of the original InputByteStream.
    
    Throws:
    
    IOException
  - slice
```
InputByteStream slice()
               throws IOException
```
    Only for internal engineering use. This api can change without notice. Create a new InputByteStream that that provides another view on the underlying data. This new InputByteStream is completely independent and can be read from and positioned without affecting the original or any other slice InputByteStream objects. The initial position of the slice is at zero - the beginning of the slice. The slice has the same bounds as the original InputByteStream. One common but probably incorrect usage of this method is to create a temporary "view" on the data that is used briefly within a method and then discarded. This is pretty wasteful and creates a number of small objects. In that case it would be better to find the current position using getPosition() and store it locally in the method and then restore the position with setPosition() before returning from the method.
    
    Returns:
    
    A slice of the original InputByteStream.
    
    Throws:
    
    IOException
  - read
```
int read()
  throws IOException
```
    Only for internal engineering use. This api can change without notice. Read the byte at the current position. If the current position is at or beyond the end of the underlying data return a -1. If not beyond the end of the underlying data the current position is incremented by 1.
    
    Returns:
    
    The byte at the current position or -1 if at or beyond EOF.
    
    Throws:
    
    IOException
  - read
```
int read(byte[] bytes,
         int position,
         int length)
  throws IOException
```
    Only for internal engineering use. This api can change without notice. Read an array of bytes starting at the current position. The position is incremented by the length of the array that has been read.
    
    Parameters:
    
    bytes - The destination array.
    
    position - The offset in the byte array to put the first byte read.
    
    length - The number of bytes to read.
    
    Throws:
    
    IOException
  - read
```
int read(byte[] bytes)
  throws IOException
```
    Only for internal engineering use. This api can change without notice. Read an array of bytes starting at the current position. The position is incremented by the length of the array that has been read.
    
    Parameters:
    
    bytes - The destination array.
    
    Throws:
    
    IOException
  - unget
```
int unget()
   throws IOException
```
    Only for internal engineering use. This api can change without notice. "Unget" the byte from underlying data. This essentially returns the byte just before the current position and sets the current position to point at that byte (one before the current position).
    
    Throws:
    
    IOException
  - seek
```
InputByteStream seek(long position)
              throws IOException
```
    Only for internal engineering use. This api can change without notice. Set the current position in the underlying data. This position is pegged to be no less than zero and no greater than the length of the InputByteStream.
    
    Parameters:
    
    position - Where to set the current position.
    
    Returns:
    
    This object.
    
    Throws:
    
    IOException
  - getPosition
```
long getPosition()
          throws IOException
```
    Only for internal engineering use. This api can change without notice. Get the current position.
    
    Returns:
    
    The current position.
    
    Throws:
    
    IOException
  - length
```
long length()
     throws IOException
```
    Only for internal engineering use. This api can change without notice. The maximum number of bytes that can be read from this InputByteStream.
    
    Returns:
    
    Total number of bytes available in this InputByteStream.
    
    Throws:
    
    IOException
  - bytesAvailable
```
long bytesAvailable()
             throws IOException
```
    Only for internal engineering use. This api can change without notice. The number of bytes available to be read from the current position.
    
    Returns:
    
    Number of bytes available from the current position in this InputByteStream.
    
    Throws:
    
    IOException
  - eof
```
boolean eof()
     throws IOException
```
    Only for internal engineering use. This api can change without notice. Is the current position of this InputByteStream at or beyond the end of the underlying data.
    
    Returns:
    
    True if the current position is beyond the end of the underlying data, false otherwise.
    
    Throws:
    
    IOException
  - close
```
void close()
    throws IOException
```
    Closes this InputByteStream and releases any system resources associated with the stream. After this method is called then any further calls to this instance are errors.
    
    Throws:
    
    IOException
  - toInputStream
```
InputStream toInputStream()
                   throws IOException
```
    Create an InputStream that represents the same data as this InputByteStream. The new InputStream is independent of the InputByteStream and operations on one will not affect the other including closing of either stream.
    
    Returns:
    
    an InputStream that refers to the same underlying data
    
    Throws:
    
    IOException

Interface InputByteStream

Field Summary

Method Summary

Field Detail

EOF

Method Detail

slice

slice

read

read

read

unget

seek

getPosition

length

bytesAvailable

eof

close

toInputStream