saker.nest Documentation TaskDoc JavaDoc Packages
public final class BundleDependencyList implements Externalizable
Holds an immutable set of bundle dependencies.

This class servers as an enclosing collection to bundle dependencies. It is used by BundleDependencyInformation to represent possibly multiple bundle dependencies for a given bundle identifier.

The class contains multiple BundleDependency instances in an ordered Set meaning that there are no duplicate dependencies, and the order remains the same between serialization and deserialization.

Use create(Collection<extends BundleDependency>) to create a new instance.

Fields
public static final BundleDependencyList
Singleton instance contanining no dependencies.
Constructors
public
Methods
public static BundleDependencyList
create(Collection<extends BundleDependency> dependencies)
Creates a new dependency list with the argument bundle dependencies.
public boolean
Indicates whether some other object is "equal to" this one.
public BundleDependencyList
filter(Function<super BundleDependency, ? extends BundleDependency> dependencytransformation)
Creates a new dependency list by filtering the dependencies in this instance.
public NavigableSet<String>
Gets all the dependency kinds which are present in any of the enclosed bundle dependency.
public Set<extends BundleDependency>
Gets the bundle dependencies enclosed in this dependency list.
public boolean
Checks if there are any optional dependencies in this instance.
public int
Returns a hash code value for the object.
public boolean
Checks if this dependency list contains any dependencies.
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 BundleDependencyList
Gets a dependency list that contains all the dependencies as this, but doesn't contain any optional dependencies.
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
public static final BundleDependencyList EMPTY
Singleton instance contanining no dependencies.
public static BundleDependencyList create(Collection<extends BundleDependency> dependencies) throws NullPointerException
Creates a new dependency list with the argument bundle dependencies.
dependenciesThe dependencies.
The created dependency list.
NullPointerExceptionIf the argument 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 BundleDependencyList filter(Function<super BundleDependency, ? extends BundleDependency> dependencytransformation) throws NullPointerException
Creates a new dependency list by filtering the dependencies in this instance.

The dependencies in this will be enumerated and the transformation function will be applied to it. If it returns null, it will be omitted.

This function can be used to transform the dependency list by filtering the dependencies in a custom manner.

dependencytransformationThe dependency transformation function.
The dependency list result of the filtering.
NullPointerExceptionIf the transformation function is null, and this is not empty.
Gets all the dependency kinds which are present in any of the enclosed bundle dependency.

This method returns an empty list if and only if isEmpty() is true.

A set of dependency kinds.
public Set<extends BundleDependency> getDependencies()
Gets the bundle dependencies enclosed in this dependency list.
An unmodifiable and ordered set of dependencies.
public boolean hasOptional()
Checks if there are any optional dependencies in this instance.
true if there was at least one BundleDependency that reported to be optional.
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 isEmpty()
Checks if this dependency list contains any dependencies.
true if there is at least one BundleDependency present in this instance.
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.
Gets a dependency list that contains all the dependencies as this, but doesn't contain any optional dependencies.

If this instance contains no optionals, this is returned, without constructing a new instance.

A dependency list without the optionals in this 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