BundleDependency

public final class BundleDependency implements Externalizable

saker.nest.bundle.BundleDependency

java.lang.Object

java.io.Externalizable

java.io.Serializable

Encloses immutable information about a bundle dependency.

Dependencies are associated with dependency kinds and are defined with a specific version range. Additionally, dependencies can contain meta-data which are arbitrary key-value string interpreted in an implementation dependent manner.

The dependency kinds are arbitrary strings that specifies in what context should a given dependency applied to the declaring entity. E.g. a dependency with classpath kind will be used to determine the bundles required on the classpath for a given bundle. See BundleInformation.DEPENDENCY_KIND_CLASSPATH.

The version range specifies the version requirements for a given dependency. When the dependencies are resolved, the version range attribute will determine if a given bundle can be used or not.

The meta-data key-value parts can be used by the dependency resolution algorithm in an implementation dependent way. These entries are to be interpreted in the context of the bundle dependency kind.
E.g. The optional meta-data is interpreted as a boolean by the classpath resolver of the Nest repository to signal that a given bundle may be omitted of not available.

Both dependency kinds and meta-data names are case sensitive and can only contain alphabetic, numeric, underscore, and dash characters.

New instances can be constructed by using the builder() method(s).

BundleDependencyInformation

BundleInformation.ENTRY_BUNDLE_DEPENDENCIES

Nested types

public static final class	Builder BundleDependency builder class.

Constructors

public	BundleDependency() For Externalizable.

Methods

public static Builder	builder() Creates a new builder.
public static Builder	builder(BundleDependency copy) Creates a new builder and initializes it with data from the argument bundle dependency.
public boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
public Set<String>	getKinds() Gets the kinds of this bundle dependency.
public Map<String, String>	getMetaData() Gets the meta-data entries of this bundle dependency.
public VersionRange	getRange() Gets the version range of this bundle dependency.
public boolean	hasKind(String kind) Checks if the argument kind is present in this bundle dependency.
public int	hashCode() Returns a hash code value for the object.
public boolean	isOptional() Checks if the dependency contains the `optional` meta-data and is associated with a `true` boolean value.
public boolean	isPrivate() Checks if the dependency contains the `private` meta-data and is associated with a `true` boolean value.
public static boolean	isValidKind(String kind) Checks if the argument is a valid dependency kind.
public static boolean	isValidMetaDataName(String name) Checks if the argument is a valid meta-data name.
public void	readExternal(ObjectInput in) 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	toString() Returns a string representation of the object.
public void	writeExternal(ObjectOutput out) 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 clone, finalize, getClass, notify, notifyAll, wait, wait, wait

public BundleDependency()

For Externalizable.

public static Builder builder()

Creates a new builder.

A new bundle dependency builder.

public static Builder builder(BundleDependency copy) throws NullPointerException

Creates a new builder and initializes it with data from the argument bundle dependency.

copyThe dependency to copy.

The new builder.

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.

Object.hashCode()

HashMap

public Set<String> getKinds()

Gets the kinds of this bundle dependency.

An unmodifiable set of dependency kinds. (Never empty.)

public Map<String, String> getMetaData()

Gets the meta-data entries of this bundle dependency.

An unmodifiable set of meta-data entries.

public VersionRange getRange()

Gets the version range of this bundle dependency.

The version range which specifies the allowed versions.

public boolean hasKind(String kind)

Checks if the argument kind is present in this bundle dependency.

kindThe kind.

true if the argument is non-null and is contained in this dependency.

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.

Object.equals(Object)

System.identityHashCode(Object)

public boolean isOptional()

Checks if the dependency contains the optional meta-data and is associated with a true boolean value.

true if the dependency was declared to be optional in the meta-datas.

BundleInformation.DEPENDENCY_META_OPTIONAL

public boolean isPrivate()

Checks if the dependency contains the private meta-data and is associated with a true boolean value.

true if the dependency was declared to be private in the meta-datas.

BundleInformation.DEPENDENCY_META_PRIVATE

saker.nest 0.8.1

public static boolean isValidKind(String kind)

Checks if the argument is a valid dependency kind.

The argument must match the [a-zA-Z_\\-0-9]+ regular expression.

kindThe kind to check its format.

true if the argument is accepted as a dependency kind.

public static boolean isValidMetaDataName(String name)

Checks if the argument is a valid meta-data name.

The argument must match the [a-zA-Z_\\-0-9]+ regular expression.

nameThe name to check its format.

true if the argument is accepted as a meta-data name.

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

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