VCDiffStreamingDecoderImpl (vcdiff-core 0.1.1 API)

java.lang.Object
- com.davidehrmann.vcdiff.engine.VCDiffStreamingDecoderImpl

All Implemented Interfaces:: VCDiffStreamingDecoder

public class VCDiffStreamingDecoderImpl
extends Object
implements VCDiffStreamingDecoder

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class VCDiffStreamingDecoderImpl.DecoratedByteArrayOutputStream

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`VCDiffStreamingDecoderImpl.DecoratedByteArrayOutputStream`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAXIMUM_TARGET_FILE_SIZE` The default maximum target file size (and target window size) if setMaximumTargetFileSize() is not called.
`static int`	`TARGET_SIZE_LIMIT` The largest value that can be passed to setMaximumTargetWindowSize().
`static int`	`UNLIMITED_BYTES` A constant that is the default value for plannedTargetFileSize, indicating that the decoder does not have an expected length for the target data.

Constructor Summary

Constructors
Constructor and Description

VCDiffStreamingDecoderImpl()

Constructors
Constructor and Description
`VCDiffStreamingDecoderImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToTotalTargetWindowSize(int window_size)`
`boolean`	`allowChecksum()`
`boolean`	`allowInterleaved()`
`boolean`	`allowVcdTarget()`
`void`	`decodeChunk(byte[] data, int offset, int len, OutputStream out)`
`void`	`decodeChunk(byte[] data, OutputStream out)` Convenience method equivalent to decodeChunk(data, 0, data.length, out)
`void`	`decodeChunk(ByteBuffer data, OutputStream out)` Accepts "data[offset,offset+length-1]" as additional data received in the compressed stream.
`ByteBuffer`	`dictionary_ptr()`
`void`	`finishDecoding()` Finishes decoding after all data has been received.
`boolean`	`hasPlannedTargetFileSize()`
`boolean`	`reachedPlannedTargetFileSize()`
`void`	`reset()`
`void`	`setAllowVcdTarget(boolean allowVcdTarget)` This interface must be called before startDecoding().
`boolean`	`setMaximumTargetFileSize(long newMaximumTargetFileSize)` Specifies the maximum allowable target file size.
`boolean`	`setMaximumTargetWindowSize(int newMaximumTargetWindowSize)` Specifies the maximum allowable target window size.
`void`	`setPlannedTargetFileSize(int planned_target_file_size)`
`void`	`startDecoding(byte[] dictionary)`
`void`	`startDecoding(ByteBuffer dictionary)` Resets the dictionary to dictionary parameter and sets up the data structures for decoding.
`void`	`targetWindowWouldExceedSizeLimits(int window_size)`

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

- Field Detail
  - DEFAULT_MAXIMUM_TARGET_FILE_SIZE
```
public static final int DEFAULT_MAXIMUM_TARGET_FILE_SIZE
```
    The default maximum target file size (and target window size) if setMaximumTargetFileSize() is not called.
    
    See Also:
    
    Constant Field Values
  - TARGET_SIZE_LIMIT
```
public static final int TARGET_SIZE_LIMIT
```
    The largest value that can be passed to setMaximumTargetWindowSize(). Using a larger value will result in an error.
    
    See Also:
    
    Constant Field Values
  - UNLIMITED_BYTES
```
public static final int UNLIMITED_BYTES
```
    A constant that is the default value for plannedTargetFileSize, indicating that the decoder does not have an expected length for the target data.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VCDiffStreamingDecoderImpl
```
public VCDiffStreamingDecoderImpl()
```
- Method Detail
  - reset
```
public void reset()
```
  - startDecoding
```
public void startDecoding(byte[] dictionary)
```
    Specified by:
    
    startDecoding in interface VCDiffStreamingDecoder
  - startDecoding
```
public void startDecoding(ByteBuffer dictionary)
```
    Description copied from interface: VCDiffStreamingDecoder
    
    Resets the dictionary to dictionary parameter and sets up the data structures for decoding. Note that the dictionary contents are not copied, and the call is responsible for ensuring that dictionary is not modified until finishDecoding is called.
    
    Specified by:
    
    startDecoding in interface VCDiffStreamingDecoder
    
    Parameters:
    
    dictionary - dictionary the decoder is initialized with
  - decodeChunk
```
public void decodeChunk(byte[] data,
                        int offset,
                        int len,
                        OutputStream out)
                 throws IOException
```
    Specified by:
    
    decodeChunk in interface VCDiffStreamingDecoder
    
    Parameters:
    
    data - data to decoder
    
    offset - offset in data to decode from
    
    len - number of bytes in data to decide
    
    out - OutputStream to write decoded data to
    
    Throws:
    
    IOException - if an error occurred decoding chunk or writing the decoded chunk to out
  - decodeChunk
```
public void decodeChunk(ByteBuffer data,
                        OutputStream out)
                 throws IOException
```
    Description copied from interface: VCDiffStreamingDecoder
    
    Accepts "data[offset,offset+length-1]" as additional data received in the compressed stream. If any chunks of data can be fully decoded, they are appended to out.
    
    Specified by:
    
    decodeChunk in interface VCDiffStreamingDecoder
    
    Parameters:
    
    data - data to decoder
    
    out - OutputStream to write decoded data to
    
    Throws:
    
    IOException - if an error occurred decoding chunk or writing the decoded chunk to out
  - decodeChunk
```
public void decodeChunk(byte[] data,
                        OutputStream out)
                 throws IOException
```
    Description copied from interface: VCDiffStreamingDecoder
    
    Convenience method equivalent to decodeChunk(data, 0, data.length, out)
    
    Specified by:
    
    decodeChunk in interface VCDiffStreamingDecoder
    
    Parameters:
    
    data - data to decoder
    
    out - OutputStream to write decoded data to
    
    Throws:
    
    IOException - if an error occurred decoding chunk or writing the decoded chunk to out
  - finishDecoding
```
public void finishDecoding()
                    throws IOException
```
    Description copied from interface: VCDiffStreamingDecoder
    
    Finishes decoding after all data has been received. finishDecoding() must be called for the current target before startDecoding() can be called for a different target.
    
    Specified by:
    
    finishDecoding in interface VCDiffStreamingDecoder
    
    Throws:
    
    IOException - if there's an error finishing decoding
  - allowInterleaved
```
public boolean allowInterleaved()
```
  - allowChecksum
```
public boolean allowChecksum()
```
  - setMaximumTargetFileSize
```
public boolean setMaximumTargetFileSize(long newMaximumTargetFileSize)
```
    Description copied from interface: VCDiffStreamingDecoder
    
    Specifies the maximum allowable target file size. If the decoder encounters a delta file that would cause it to create a target file larger than this limit, it will throw an IOException and stop decoding. If the decoder is applied to delta files whose sizes vary greatly and whose contents can be trusted, then a value larger than the the default value (64 MB) can be specified to allow for maximum flexibility. On the other hand, if the input data is known never to exceed a particular size, and/or the input data may be maliciously constructed, a lower value can be supplied in order to guard against running out of memory or swapping to disk while decoding an extremely large target file. The argument must be between 0 and INT32_MAX (2G); if it is within these bounds, the function will set the limit and return true. Otherwise, the function will return false and will not change the limit. Setting the limit to 0 will cause all decode operations of non-empty target files to fail.
    
    Specified by:
    
    setMaximumTargetFileSize in interface VCDiffStreamingDecoder
    
    Parameters:
    
    newMaximumTargetFileSize - maximum size allowed output size
    
    Returns:
    
    whether or not the maximum target file size was changed successfully
  - setMaximumTargetWindowSize
```
public boolean setMaximumTargetWindowSize(int newMaximumTargetWindowSize)
```
    Description copied from interface: VCDiffStreamingDecoder
    
    Specifies the maximum allowable target *window* size. (A target file is composed of zero or more target windows.) If the decoder encounters a delta window that would cause it to create a target window larger than this limit, it will log an error and stop decoding.
    
    Specified by:
    
    setMaximumTargetWindowSize in interface VCDiffStreamingDecoder
    
    Parameters:
    
    newMaximumTargetWindowSize - maximum size of target windows allowed
    
    Returns:
    
    whether or not the maximum target window size was changed successfully
  - hasPlannedTargetFileSize
```
public boolean hasPlannedTargetFileSize()
```
  - setPlannedTargetFileSize
```
public void setPlannedTargetFileSize(int planned_target_file_size)
```
  - addToTotalTargetWindowSize
```
public void addToTotalTargetWindowSize(int window_size)
```
  - reachedPlannedTargetFileSize
```
public boolean reachedPlannedTargetFileSize()
```
  - targetWindowWouldExceedSizeLimits
```
public void targetWindowWouldExceedSizeLimits(int window_size)
                                       throws IOException
```
    Throws:
    
    IOException
  - dictionary_ptr
```
public ByteBuffer dictionary_ptr()
```
  - allowVcdTarget
```
public boolean allowVcdTarget()
```
  - setAllowVcdTarget
```
public void setAllowVcdTarget(boolean allowVcdTarget)
```
    Description copied from interface: VCDiffStreamingDecoder
    
    This interface must be called before startDecoding(). If its argument is true, then the VCD_TARGET flag can be specified to allow the source segment to be chosen from the previously-decoded target data. (This is the default behavior.) If it is false, then specifying the VCD_TARGET flag is considered an error, and the decoder does not need to keep in memory any decoded target data prior to the current window.
    
    Specified by:
    
    setAllowVcdTarget in interface VCDiffStreamingDecoder
    
    Parameters:
    
    allowVcdTarget - whether or not to allow the decoder to use decoded VCD data as a target

Class VCDiffStreamingDecoderImpl

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAXIMUM_TARGET_FILE_SIZE

TARGET_SIZE_LIMIT

UNLIMITED_BYTES

Constructor Detail

VCDiffStreamingDecoderImpl

Method Detail

reset

startDecoding

startDecoding

decodeChunk

decodeChunk

decodeChunk

finishDecoding

allowInterleaved

allowChecksum

setMaximumTargetFileSize

setMaximumTargetWindowSize

hasPlannedTargetFileSize

setPlannedTargetFileSize

addToTotalTargetWindowSize

reachedPlannedTargetFileSize

targetWindowWouldExceedSizeLimits

dictionary_ptr

allowVcdTarget

setAllowVcdTarget