XZ for Java 1.9 · org.tukaani.xz.BCJOptions

Modifier and Type	Field and Description
private final int	alignment
pack-priv int	startOffset

Access	Constructor and Description
pack-priv	BCJOptions(int alignment)

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public int	getDecoderMemoryUsage() Implements abstract org.tukaani.xz.FilterOptions.getDecoderMemoryUsage. Gets how much memory the decoder will need to decompress the data that was encoded with these options.
public int	getEncoderMemoryUsage() Implements abstract org.tukaani.xz.FilterOptions.getEncoderMemoryUsage. Gets how much memory the encoder will need with these options.
public int	getStartOffset() Gets the start offset.
public void	setStartOffset(int startOffset) Sets the start offset for the address conversions.

Inherited from org.tukaani.xz.FilterOptions:: getDecoderMemoryUsage getEncoderMemoryUsage getFilterEncoder getInputStream getInputStream getOutputStream getOutputStream

alignment	back to summary
private final int alignment

startOffset	back to summary
pack-priv int startOffset

BCJOptions	back to summary
pack-priv BCJOptions(int alignment)

Method Detail

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance.

public Object clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object: a clone of this instance.

getDecoderMemoryUsage	back to summary
public int getDecoderMemoryUsage() Implements abstract org.tukaani.xz.FilterOptions.getDecoderMemoryUsage. Doc from org.tukaani.xz.FilterOptions.getDecoderMemoryUsage. Gets how much memory the decoder will need to decompress the data that was encoded with these options.

getDecoderMemoryUsage

back to summary

public int getDecoderMemoryUsage()

Implements abstract org.tukaani.xz.FilterOptions.getDecoderMemoryUsage.

Doc from org.tukaani.xz.FilterOptions.getDecoderMemoryUsage.

Gets how much memory the decoder will need to decompress the data that was encoded with these options.

getEncoderMemoryUsage	back to summary
public int getEncoderMemoryUsage() Implements abstract org.tukaani.xz.FilterOptions.getEncoderMemoryUsage. Doc from org.tukaani.xz.FilterOptions.getEncoderMemoryUsage. Gets how much memory the encoder will need with these options.

getEncoderMemoryUsage

back to summary

public int getEncoderMemoryUsage()

Implements abstract org.tukaani.xz.FilterOptions.getEncoderMemoryUsage.

Doc from org.tukaani.xz.FilterOptions.getEncoderMemoryUsage.

Gets how much memory the encoder will need with these options.

getStartOffset	back to summary
public int getStartOffset() Gets the start offset.

setStartOffset	back to summary
public void setStartOffset(int startOffset) throws UnsupportedOptionsException Sets the start offset for the address conversions. Normally this is useless so you shouldn't use this function. The default value is `0`.

pack-priv abstract Class BCJOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail