io.knotx.stack.model

Class Dependency

java.lang.Object

org.apache.maven.model.Dependency

io.knotx.stack.model.Dependency

All Implemented Interfaces:

Serializable, Cloneable, org.apache.maven.model.InputLocationTracker

public class Dependency
extends org.apache.maven.model.Dependency

Represents a dependency. The stack describes a set of dependencies resolved as Maven dependencies. Each dependency can be included or excluded and can instruct whether the resolution need to bring the transitive dependencies too. Be aware the dependencies cannot be set as "optional', as optionality do not make sense when we deploy the artifact.

Author:

Clement Escoffier

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Dependency() Creates a new Dependency.
Dependency(String groupId, String artifactId, String version) Creates a new Dependency.
Dependency(String groupId, String artifactId, String version, String type) Creates a new Dependency.

Method Summary

Modifier and Type	Method and Description
String	getGACV()
ResolutionOptions	getResolutionOptions() Creates the ResolutionOptions object for the dependency.
boolean	isIncluded()
boolean	isTransitive()
Dependency	setIncluded(boolean included) Sets whether or not the dependency is included.
void	setOptional(boolean optional) Not supported property, as the concept of 'optional' does not make sense when building a stack.
Dependency	setTransitive(boolean transitive) Sets whether or not the dependency resolution also resolves the transitive dependencies.

Methods inherited from class org.apache.maven.model.Dependency

addExclusion, clone, getArtifactId, getClassifier, getExclusions, getGroupId, getLocation, getManagementKey, getOptional, getScope, getSystemPath, getType, getVersion, isOptional, removeExclusion, setArtifactId, setClassifier, setExclusions, setGroupId, setLocation, setOptional, setScope, setSystemPath, setType, setVersion, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Dependency

public Dependency(String groupId,
                  String artifactId,
                  String version)

Creates a new Dependency.

Parameters:

groupId - the groupId

artifactId - the artifactId

version - the version

Dependency

public Dependency(String groupId,
                  String artifactId,
                  String version,
                  String type)

Creates a new Dependency.

Parameters:

groupId - the groupId

artifactId - the artifactId

version - the version

type - the type / extension / packaging

Dependency

public Dependency()

Creates a new Dependency. The type is set to "jar" by default.

Method Detail

isIncluded

public boolean isIncluded()

Returns:

true if the dependency is included, false otherwise.

setIncluded

public Dependency setIncluded(boolean included)

Sets whether or not the dependency is included. Included by default.

Parameters:

included - true/false

Returns:

the current Dependency instance.

isTransitive

public boolean isTransitive()

Returns:

true if the dependency must be resolved with its transitive dependencies.

setTransitive

public Dependency setTransitive(boolean transitive)

Sets whether or not the dependency resolution also resolves the transitive dependencies. Transitive dependencies are resolved by default.

Parameters:

transitive - true/false

Returns:

the current Dependency instance.

getResolutionOptions

public ResolutionOptions getResolutionOptions()

Creates the ResolutionOptions object for the dependency.

Returns:

the ResolutionOptions instructing the dependency resolution.

getGACV

public String getGACV()

Returns:

the Maven GACV string.

setOptional

public void setOptional(boolean optional)

Not supported property, as the concept of 'optional' does not make sense when building a stack.

Overrides:

setOptional in class org.apache.maven.model.Dependency

Parameters:

optional - ignored