saker.zip Documentation TaskDoc JavaDoc Packages
public final class ZipResourceEntry implements Externalizable
Immutable data class containing information about an entry in a ZIP archive.

This class is used to convey information about ZIP archive entries during archive creation and transformation. It is mainly used to change the attributes of the output ZIP entries.

Use the static factory methods to get a new instance.

saker.zip 0.8.5
Constructors
public
Don't use, this constructor is only to support Externalizable interface.
Methods
public ZipResourceEntry
Creates a new instance by setting the compression method to DEFLATED and setting the compression level to default.
public ZipResourceEntry
asDeflatedEntry(int level)
Creates a new instance by setting the compression method to DEFLATED and setting the compression level.
public ZipResourceEntry
Creates a new instance by copying this one and setting the compression method to STORED.
public static ZipResourceEntry
create(SakerPath entrypath)
Creates a new instance with the given entry path.
public static ZipResourceEntry
create(SakerPath entrypath, FileTime modificationTime)
Creates a new instance with the given entry path and modification time.
public static ZipResourceEntry
deflated(SakerPath entrypath)
Creates a new instance with the given entry path and DEFLATED compression.
public static ZipResourceEntry
deflated(SakerPath entrypath, int level)
Creates a new instance with the given entry path and the specified level of DEFLATED compression.
public static ZipResourceEntry
deflated(SakerPath entrypath, FileTime modificationTime)
Creates a new instance with the given entry path, modification time and DEFLATED compression.
public static ZipResourceEntry
deflated(SakerPath entrypath, FileTime modificationTime, int level)
Creates a new instance with the given entry path, modification time and the specified level of DEFLATED compression.
public boolean
Indicates whether some other object is "equal to" this one.
public static ZipResourceEntry
from(ZipEntry zipentry)
Creates a new instance based on the argument ZipEntry.
public SakerPath
Gets the entry path in the ZIP archive.
public int
Gets the compression level that should be used for deflate compression.
public int
Gets the compression method constant.
public FileTime
Gets the modification time of the entry.
public int
Returns a hash code value for the object.
public void
The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
public static ZipResourceEntry
stored(SakerPath entrypath)
Creates a new instance with the given entry path and no compression (STORED) .
public static ZipResourceEntry
stored(SakerPath entrypath, FileTime modificationTime)
Creates a new instance with the given entry path, modification time and no compression (STORED).
public String
Returns a string representation of the object.
public ZipResourceEntry
Creates a new instance with a new entry path.
public ZipResourceEntry
withModificationTime(FileTime modificationTime)
Creates a new instance that has a different modification time.
public void
The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.
Inherited methods
From: Object
Don't use, this constructor is only to support Externalizable interface.
Creates a new instance by setting the compression method to DEFLATED and setting the compression level to default.
The new instance.
Creates a new instance by setting the compression method to DEFLATED and setting the compression level.
levelThe compression leve.
The new instance.
Creates a new instance by copying this one and setting the compression method to STORED.
The new instance.
public static ZipResourceEntry create(SakerPath entrypath) throws NullPointerException
Creates a new instance with the given entry path.
entrypathThe entry path.
The new instance.
NullPointerExceptionIf the entry path is null.
public static ZipResourceEntry create(SakerPath entrypath, FileTime modificationTime) throws NullPointerException
Creates a new instance with the given entry path and modification time.
entrypathThe entry path.
modificationTimeThe last modification time.
NullPointerExceptionIf the entry path is null.
public static ZipResourceEntry deflated(SakerPath entrypath) throws NullPointerException
Creates a new instance with the given entry path and DEFLATED compression.
entrypathThe entry path.
The new instance.
NullPointerExceptionIf the entry path is null.
public static ZipResourceEntry deflated(SakerPath entrypath, int level) throws NullPointerException
Creates a new instance with the given entry path and the specified level of DEFLATED compression.
entrypathThe entry path.
levelThe compression level.
The new instance.
NullPointerExceptionIf the entry path is null.
public static ZipResourceEntry deflated(SakerPath entrypath, FileTime modificationTime) throws NullPointerException
Creates a new instance with the given entry path, modification time and DEFLATED compression.
entrypathThe entry path.
modificationTimeThe last modification time.
The new instance.
NullPointerExceptionIf the entry path is null.
public static ZipResourceEntry deflated(SakerPath entrypath, FileTime modificationTime, int level) throws NullPointerException
Creates a new instance with the given entry path, modification time and the specified level of DEFLATED compression.
entrypathThe entry path.
modificationTimeThe last modification time.
levelThe compression level.
The new instance.
NullPointerExceptionIf the entry path is null.
public boolean equals(Object obj)
Overridden from: Object
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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

objthe reference object with which to compare.
true if this object is the same as the obj argument; false otherwise.
public static ZipResourceEntry from(ZipEntry zipentry) throws NullPointerException
Creates a new instance based on the argument ZipEntry.
zipentryThe ZIP entry.
The new instance.
NullPointerExceptionIf the zip entry is null.
Gets the entry path in the ZIP archive.
The entry path, not null.
public int getLevel()
Gets the compression level that should be used for deflate compression.
The compression level or negative integer if the default compression level is to be used.
public int getMethod()
Gets the compression method constant.

The value is one of the ZipEntry method constants.

The compression method, or negative integer if not set.
Gets the modification time of the entry.

If the modification time is null, then it may be unknown, or the default modification time will be used when creating the associated ZIP entry.

The modification time or null if not available.
public int hashCode()
Overridden from: Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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(Object) 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 Object.equals(Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

a hash code value for this object.
Overridden from: Externalizable
The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.
inthe stream to read data from in order to restore the object
IOExceptionif I/O errors occur
ClassNotFoundExceptionIf the class for an object being restored cannot be found.
public static ZipResourceEntry stored(SakerPath entrypath) throws NullPointerException
Creates a new instance with the given entry path and no compression (STORED) .
entrypathThe entry path.
The new instance.
NullPointerExceptionIf the entry path is null.
public static ZipResourceEntry stored(SakerPath entrypath, FileTime modificationTime) throws NullPointerException
Creates a new instance with the given entry path, modification time and no compression (STORED).
entrypathThe entry path.
modificationTimeThe last modification time.
The new instance.
NullPointerExceptionIf the entry path is null.
public String toString()
Overridden from: Object
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 
a string representation of the object.
Creates a new instance with a new entry path.
entryPathThe entry path.
The new instance.
NullPointerExceptionIf the entry path is null
Creates a new instance that has a different modification time.
modificationTimeThe modification time.
The new instance.
public void writeExternal(ObjectOutput out) throws IOException
Overridden from: Externalizable
The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.
outthe stream to write the object to
IOExceptionIncludes any I/O exceptions that may occur