org.fabric3.spi.contribution.manifest

Class PackageInfo

java.lang.Object

org.fabric3.spi.model.version.Versionable

org.fabric3.spi.contribution.manifest.PackageInfo

All Implemented Interfaces:

java.io.Serializable

public final class PackageInfo
extends Versionable

Represents Java package information specified in a Java import or export contribution manifest declaration.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.fabric3.spi.model.version.Versionable

maxInclusive, maxVersion, minInclusive, minVersion

Constructor Summary

Constructors

Constructor and Description
PackageInfo() Default constructor.
PackageInfo(java.lang.String name) Constructor for an import or export package declaration.
PackageInfo(java.lang.String name, boolean required) Constructor for an import package declaration specifying if it is required.
PackageInfo(java.lang.String name, org.fabric3.api.host.Version version) Constructor for an export package declaration.
PackageInfo(java.lang.String name, org.fabric3.api.host.Version version, boolean minInclusive, boolean required) Constructor for an import or export package declaration specifying an exact version.
PackageInfo(java.lang.String name, org.fabric3.api.host.Version minVersion, boolean minInclusive, org.fabric3.api.host.Version maxVersion, boolean maxInclusive, boolean required) Constructor for an import package declaration specifying a version range.

Method Summary

Modifier and Type	Method and Description
org.fabric3.api.host.Version	getMaxVersion() The maximum required version.
org.fabric3.api.host.Version	getMinVersion() The minimum required version.
java.lang.String	getName() The package name.
int	hashCode()
boolean	isMaxInclusive() True if the maximum version range is exclusive.
boolean	isMinInclusive() True if the minimum version range is exclusive.
boolean	isRequired() Returns true if the package is required.
boolean	matches(PackageInfo exportPackage) Returns true if this import package matches the specified export package according to OSGi R4 semantics.
void	setMaxInclusive(boolean maxInclusive) Sets if the maximum version range is exclusive.
void	setMaxVersion(org.fabric3.api.host.Version maxVersion) Sets the maximum required version.
void	setMinInclusive(boolean minInclusive) Sets if the minimum version range is exclusive
void	setMinVersion(org.fabric3.api.host.Version minVersion) Sets the minimum required version.
void	setName(java.lang.String name) Sets the package name
void	setRequired(boolean required) True if the package is required.
java.lang.String	toString()

Methods inherited from class org.fabric3.spi.model.version.Versionable

matches

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PackageInfo

public PackageInfo(java.lang.String name,
                   org.fabric3.api.host.Version minVersion,
                   boolean minInclusive,
                   org.fabric3.api.host.Version maxVersion,
                   boolean maxInclusive,
                   boolean required)

Constructor for an import package declaration specifying a version range.

Parameters:

name - the package name

minVersion - the minimum version

minInclusive - true if the minimum version is considered inclusive for range matching

maxVersion - the maximum version

maxInclusive - if the maximum version is considered inclusive for range matching

required - if package resolution is required

PackageInfo

public PackageInfo(java.lang.String name,
                   org.fabric3.api.host.Version version,
                   boolean minInclusive,
                   boolean required)

Constructor for an import or export package declaration specifying an exact version.

Parameters:

name - the package name

version - the minimum version

minInclusive - true if the minimum version is considered inclusive for range matching

required - if package resolution is required

PackageInfo

public PackageInfo(java.lang.String name)

Constructor for an import or export package declaration.

Parameters:

name - the package name

PackageInfo

public PackageInfo(java.lang.String name,
                   org.fabric3.api.host.Version version)

Constructor for an export package declaration.

Parameters:

name - the package name

version - the version

PackageInfo

public PackageInfo(java.lang.String name,
                   boolean required)

Constructor for an import package declaration specifying if it is required.

Parameters:

name - the package name

required - if package resolution is required

PackageInfo

public PackageInfo()

Default constructor.

Method Detail

getName

public java.lang.String getName()

The package name.

Returns:

package name

setName

public void setName(java.lang.String name)

Sets the package name

Parameters:

name - the package name

getMinVersion

public org.fabric3.api.host.Version getMinVersion()

The minimum required version. When no maximum version is specified, the minimum version is interpreted as a specific required version.

Overrides:

getMinVersion in class Versionable

Returns:

the version

setMinVersion

public void setMinVersion(org.fabric3.api.host.Version minVersion)

Sets the minimum required version.

Overrides:

setMinVersion in class Versionable

Parameters:

minVersion - the minimum required version.

isMinInclusive

public boolean isMinInclusive()

True if the minimum version range is exclusive.

Overrides:

isMinInclusive in class Versionable

Returns:

true if the minimum version range is exclusive.

setMinInclusive

public void setMinInclusive(boolean minInclusive)

Sets if the minimum version range is exclusive

Overrides:

setMinInclusive in class Versionable

Parameters:

minInclusive - true if the minimum version range is exclusive

getMaxVersion

public org.fabric3.api.host.Version getMaxVersion()

The maximum required version. When no maximum version is specified, the minimum version is interpreted as a specific required version.

Overrides:

getMaxVersion in class Versionable

Returns:

the maximum version or null

setMaxVersion

public void setMaxVersion(org.fabric3.api.host.Version maxVersion)

Sets the maximum required version.

Overrides:

setMaxVersion in class Versionable

Parameters:

maxVersion - maximum version

isMaxInclusive

public boolean isMaxInclusive()

True if the maximum version range is exclusive.

Overrides:

isMaxInclusive in class Versionable

Returns:

true if the maximum version range is exclusive.

setMaxInclusive

public void setMaxInclusive(boolean maxInclusive)

Sets if the maximum version range is exclusive.

Overrides:

setMaxInclusive in class Versionable

Parameters:

maxInclusive - true if the maximum version range is exclusive

isRequired

public boolean isRequired()

Returns true if the package is required.

Returns:

true if the package is required

setRequired

public void setRequired(boolean required)

True if the package is required.

Parameters:

required - true if the package is required

matches

public boolean matches(PackageInfo exportPackage)

Returns true if this import package matches the specified export package according to OSGi R4 semantics.

Parameters:

exportPackage - the export package

Returns:

true if this import package matches the specified export package

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object