Apache Ant Core 1.10.14 · org.apache.tools.zip.GeneralPurposeBit

Modifier and Type	Field and Description
private static final int	DATA_DESCRIPTOR_FLAG Indicates that a data descriptor stored after the file contents will hold CRC and size information.
private boolean	dataDescriptorFlag
private static final int	ENCRYPTION_FLAG Indicates that the file is encrypted.
private boolean	encryptionFlag
private boolean	languageEncodingFlag
private static final int	STRONG_ENCRYPTION_FLAG Indicates strong encryption.
private boolean	strongEncryptionFlag
public static final int	UFT8_NAMES_FLAG Indicates that filenames are written in utf-8.

Access	Constructor and Description
public	GeneralPurposeBit()

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 byte[]	Returns: byte[] encode() Encodes the set bits in a form suitable for ZIP archives.
public void	encode(byte[] the output buffer buf, int The offset within the output buffer of the first byte to be written. must be non-negative and no larger than `buf.length-2` offset) Encodes the set bits in a form suitable for ZIP archives.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public static GeneralPurposeBit	Returns: GeneralPurposeBit parse(final byte[] local file header or a central directory entry. data, final int offset at which the general purpose bit starts offset) Parses the supported flags from the given archive data.
public void	useDataDescriptor(boolean boolean b) whether the current entry will use the data descriptor to store CRC and size information
public void	useEncryption(boolean boolean b) whether the current entry will be encrypted
public boolean	Returns: boolean usesDataDescriptor() whether the current entry uses the data descriptor to store CRC and size information
public boolean	Returns: boolean usesEncryption() whether the current entry is encrypted
public boolean	Returns: boolean usesStrongEncryption() whether the current entry is encrypted using strong encryption
public void	useStrongEncryption(boolean boolean b) whether the current entry will be encrypted using strong encryption
public boolean	Returns: boolean usesUTF8ForNames() whether the current entry uses UTF8 for file name and comment.
public void	useUTF8ForNames(boolean boolean b) whether the current entry will use UTF8 for file name and comment.

Inherited from java.lang.Object:: finalize getClass notify notifyAll toString wait wait wait

DATA_DESCRIPTOR_FLAG	back to summary
private static final int DATA_DESCRIPTOR_FLAG Indicates that a data descriptor stored after the file contents will hold CRC and size information.

dataDescriptorFlag	back to summary
private boolean dataDescriptorFlag

ENCRYPTION_FLAG	back to summary
private static final int ENCRYPTION_FLAG Indicates that the file is encrypted.

encryptionFlag	back to summary
private boolean encryptionFlag

languageEncodingFlag	back to summary
private boolean languageEncodingFlag

STRONG_ENCRYPTION_FLAG	back to summary
private static final int STRONG_ENCRYPTION_FLAG Indicates strong encryption.

strongEncryptionFlag	back to summary
private boolean strongEncryptionFlag

UFT8_NAMES_FLAG	back to summary
public static final int UFT8_NAMES_FLAG Indicates that filenames are written in utf-8. The only reason this is public is that `ZipOutputStream#EFS_FLAG` was public in several versions of Apache Ant and we needed a substitute for it.

GeneralPurposeBit	back to summary
public GeneralPurposeBit()

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. Annotations @Override

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.

Annotations

@Override

encode	back to summary
public byte[] encode() Encodes the set bits in a form suitable for ZIP archives. Returns:byte[] byte[]

encode

back to summary

public byte[] encode()

Encodes the set bits in a form suitable for ZIP archives.

Returns:byte[]: byte[]

encode back to summary

encode	back to summary
public void encode(byte[] buf, int offset) Encodes the set bits in a form suitable for ZIP archives. Parameters buf:byte[] the output buffer offset:int The offset within the output buffer of the first byte to be written. must be non-negative and no larger than `buf.length-2`

public void encode(byte[] buf, int offset)

Encodes the set bits in a form suitable for ZIP archives.

Parameters

buf:byte[]: the output buffer
offset:int: The offset within the output buffer of the first byte to be written. must be non-negative and no larger than buf.length-2

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

parse	back to summary
public static GeneralPurposeBit parse(final byte[] data, final int offset) Parses the supported flags from the given archive data. Parameters data:byte[] local file header or a central directory entry. offset:int offset at which the general purpose bit starts Returns:GeneralPurposeBit GeneralPurposeBit

parse

back to summary

public static GeneralPurposeBit parse(final byte[] data, final int offset)

Parses the supported flags from the given archive data.

Parameters

data:byte[]: local file header or a central directory entry.
offset:int: offset at which the general purpose bit starts

Returns:GeneralPurposeBit

GeneralPurposeBit

useDataDescriptor	back to summary
public void useDataDescriptor(boolean b) whether the current entry will use the data descriptor to store CRC and size information Parameters b:boolean boolean

useDataDescriptor

back to summary

public void useDataDescriptor(boolean b)

whether the current entry will use the data descriptor to store CRC and size information

Parameters

b:boolean: boolean

useEncryption	back to summary
public void useEncryption(boolean b) whether the current entry will be encrypted Parameters b:boolean boolean

useEncryption

back to summary

public void useEncryption(boolean b)

whether the current entry will be encrypted

Parameters

b:boolean: boolean

usesDataDescriptor	back to summary
public boolean usesDataDescriptor() whether the current entry uses the data descriptor to store CRC and size information Returns:boolean boolean

usesDataDescriptor

back to summary

public boolean usesDataDescriptor()

whether the current entry uses the data descriptor to store CRC and size information

Returns:boolean: boolean

usesEncryption	back to summary
public boolean usesEncryption() whether the current entry is encrypted Returns:boolean boolean

usesEncryption

back to summary

public boolean usesEncryption()

whether the current entry is encrypted

Returns:boolean: boolean

usesStrongEncryption	back to summary
public boolean usesStrongEncryption() whether the current entry is encrypted using strong encryption Returns:boolean boolean

usesStrongEncryption

back to summary

public boolean usesStrongEncryption()

whether the current entry is encrypted using strong encryption

Returns:boolean: boolean

useStrongEncryption	back to summary
public void useStrongEncryption(boolean b) whether the current entry will be encrypted using strong encryption Parameters b:boolean boolean

useStrongEncryption

back to summary

public void useStrongEncryption(boolean b)

whether the current entry will be encrypted using strong encryption

Parameters

b:boolean: boolean

usesUTF8ForNames	back to summary
public boolean usesUTF8ForNames() whether the current entry uses UTF8 for file name and comment. Returns:boolean boolean

usesUTF8ForNames

back to summary

public boolean usesUTF8ForNames()

whether the current entry uses UTF8 for file name and comment.

Returns:boolean: boolean

useUTF8ForNames	back to summary
public void useUTF8ForNames(boolean b) whether the current entry will use UTF8 for file name and comment. Parameters b:boolean boolean

useUTF8ForNames

back to summary

public void useUTF8ForNames(boolean b)

whether the current entry will use UTF8 for file name and comment.

Parameters

b:boolean: boolean

public final Class GeneralPurposeBit

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail