saker.nest Documentation TaskDoc JavaDoc Packages
public final class ExternalAttachmentInformation implements Externalizable
Contains information about an external dependency attachment.

The class is an immutable information container about an attachment for a given external dependency. The class contains hash information, meta-data, and entry specification for the attachment.

Use builder() to create a new instance.

saker.nest 0.8.5
Nested types
public static final class
Fields
public static final ExternalAttachmentInformation
A singleton instance that contains no properties.
Methods
public static Builder
Creates a new ExternalAttachmentInformation builder.
public boolean
Indicates whether some other object is "equal to" this one.
public Set<WildcardPath>
Gets the entries that this attachment is associated with.
public String
Gets the expected MD5 hash.
public Map<String, String>
Gets the meta-data entries of this external attachment.
public String
Gets the expected SHA-1 hash.
public String
Gets the expected SHA-256 hash.
public NavigableSet<WildcardPath>
Gets the entries that this attachment is defined for.
public int
Returns a hash code value for the object.
public boolean
Checks if the main archive is included by this attachment.
public boolean
Checks if the attachment is defined for the main archive.
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 String
Returns a string representation of the object.
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
A singleton instance that contains no properties.

It includes the main archive and targets the main archive.

public static Builder builder()
Creates a new ExternalAttachmentInformation builder.
The builder.
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.
Gets the entries that this attachment is associated with.

The entries are retrieved from the URI of the attachment declaration by interpreting it as a ZIP archive and finding the entries that match any of the returned wildcards.

An unmodifiable set of wildcards specifying the entries.
Gets the expected MD5 hash.
The MD5 hash in lowercase hexa format or null if none.
Gets the meta-data entries of this external attachment.
An unmodifiable set of meta-data entries.
Gets the expected SHA-1 hash.
The SHA-1 hash in lowercase hexa format or null if none.
Gets the expected SHA-256 hash.
The SHA-256 hash in lowercase hexa format or null if none.
Gets the entries that this attachment is defined for.

The target entries are the ones that the attachment is attached to. The entries are retrieved from the URI of the dependency declaration by interpreting it as a ZIP archive and finding the entries that match any of the returned wildcards.

An unmodifiable set of wildcards specifying the target entries.
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.
public boolean isIncludesMainArchive()
Checks if the main archive is included by this attachment.

The main archive is the file that the URI of the attachment declaration points to.

true if the main archive is included.
public boolean isTargetsMainArchive()
Checks if the attachment is defined for the main archive.

The main archive is the file that the URI of the attachment declaration points to.

true if the main archive is included.
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 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.
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