net.ossindex.common.utils

Class PackageDependency

java.lang.Object

net.ossindex.common.utils.PackageDependency

public class PackageDependency
extends Object

Define a dependency from an artifact to a package/version. This class also provides mechanisms for adding additional data, such as the artifact defined by the dependency package/version, and the SCM that contains the source for the artifact.

Author:

Ken Duck

Constructor Summary

Constructors

Constructor and Description
PackageDependency(FilePosition position, String pkgManager, String pkgName, String version) Create a package dependency
PackageDependency(FilePosition position, String pkgManager, String groupId, String pkgName, String version)
PackageDependency(String pkgManager, String pkgName, String version) Create a package dependency
PackageDependency(String pkgManager, String groupId, String artifactId, String version) Create a package dependency

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ArtifactResource	getArtifact() Get the artifact for this dependency
String	getDescription() Get a description of the dependency
String	getGroupId() Get the group id/name
String	getId() Get the simple fully descriptive ID for the package
int	getLength() Length of the selection
int	getLine() Get the line number of the dependency owner file that defines this dependency
String	getName() Get the artifact id/name
int	getOffset() Get the character offset
boolean	getOptional() Is this an optional dependency?
String	getPackageManager() Get the package manager name
ScmResource	getScm() Get the SCM resource that is deemed to be the dependency source
String	getVersion() Get the package version
VulnerabilityResource[]	getVulnerabilities() Get the vulnerabilities that apply to the package
int	hashCode()
boolean	isRoot() Is this a root package, which means it is directly referenced (as opposed to transitively).
void	setArtifact(ArtifactResource artifact) Set the artifact that is deemed to be the best match.
void	setIsRoot(boolean b) Is this a root package, which means it is directly referenced (as opposed to transitively).
void	setOptional(Boolean optional) Indicates that this is an "optional" package
void	setScm(ScmResource scmResource) Set the SCM resource that is deemed to be the dependency source
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageDependency

public PackageDependency(FilePosition position,
                         String pkgManager,
                         String pkgName,
                         String version)

Create a package dependency

Parameters:

position - Position of the dependency

pkgManager - Package manager the dependency belongs to

pkgName - The package name

version - The version

PackageDependency

public PackageDependency(FilePosition position,
                         String pkgManager,
                         String groupId,
                         String pkgName,
                         String version)

Parameters:

position -

pkgManager -

groupId -

pkgName -

version -

PackageDependency

public PackageDependency(String pkgManager,
                         String pkgName,
                         String version)

Create a package dependency

Parameters:

pkgManager - Package manager the dependency belongs to

pkgName - The package name

version - The version

PackageDependency

public PackageDependency(String pkgManager,
                         String groupId,
                         String artifactId,
                         String version)

Create a package dependency

Parameters:

pkgManager - Package manager the dependency belongs to

groupId - The groupId of the package

artifactId - The artifact name

version - The version

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getPackageManager

public String getPackageManager()

Get the package manager name

Returns:

The package manager name

getName

public String getName()

Get the artifact id/name

Returns:

The package name

getGroupId

public String getGroupId()

Get the group id/name

Returns:

The group ID name

getVersion

public String getVersion()

Get the package version

Returns:

The version string

getLine

public int getLine()

Get the line number of the dependency owner file that defines this dependency

Returns:

File line the package was found at

getOffset

public int getOffset()

Get the character offset

Returns:

Character offset the package was found at

getLength

public int getLength()

Length of the selection

Returns:

Length of the selection

toString

public String toString()

Overrides:

toString in class Object

setArtifact

public void setArtifact(ArtifactResource artifact)

Set the artifact that is deemed to be the best match.

Parameters:

artifact - Set the artifact for the package

setScm

public void setScm(ScmResource scmResource)

Set the SCM resource that is deemed to be the dependency source

Parameters:

scmResource - The SCM resource that was found for the package

getArtifact

public ArtifactResource getArtifact()

Get the artifact for this dependency

Returns:

The artifact belonging to the dependency

getScm

public ScmResource getScm()

Get the SCM resource that is deemed to be the dependency source

Returns:

The SCM the package belongs to

getDescription

public String getDescription()

Get a description of the dependency

Returns:

The package description

getVulnerabilities

public VulnerabilityResource[] getVulnerabilities()
                                           throws IOException

Get the vulnerabilities that apply to the package

Returns:

An array of vulnerabilities that affect the package

Throws:

IOException - On error

getId

public String getId()

Get the simple fully descriptive ID for the package

Returns:

Return a string ID describing the package

setOptional

public void setOptional(Boolean optional)

Indicates that this is an "optional" package

Parameters:

optional - True if this is an optional package

getOptional

public boolean getOptional()

Is this an optional dependency?

Returns:

True if this is an optional package

setIsRoot

public void setIsRoot(boolean b)

Is this a root package, which means it is directly referenced (as opposed to transitively).

Parameters:

b - True if this is a root package

isRoot

public boolean isRoot()

Is this a root package, which means it is directly referenced (as opposed to transitively).

Returns:

True if this package is the "root" package