Package org.apache.jackrabbit.vault.packaging

Class Dependency

java.lang.Object

org.apache.jackrabbit.vault.packaging.Dependency

public class Dependency
extends Object

Implements a package dependency reference.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
static Dependency[]	EMPTY	An empty dependency array

Constructor Summary

Constructors

Constructor	Description
Dependency(String groupId, String name, VersionRange range)	Creates a new dependency reference.
Dependency(PackageId id)	Creates a new dependency to the specified package id

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static Dependency	fromString(String str)	Returns a dependency from a string.
static Dependency[]	fromString(String... str)	Returns dependencies from the given strings.
String	getGroup()	Returns the group of the dependency
String	getName()	Returns the name of the dependency
String	getPath()	Deprecated. As of 3.1.42, the storage location is implementation details.
VersionRange	getRange()	Returns the version range
int	hashCode()
boolean	matches(PackageId id)	Checks if the given package id matches this dependency specification.
static Dependency[]	parse(String str)	Parses a string serialization of dependency references generated by toString(Dependency...))}
String	toString()
static String	toString(Dependency... deps)	Returns a string representation from given dependencies.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final Dependency[] EMPTY

An empty dependency array

Constructor Detail

Dependency

public Dependency(@Nonnull
                  String groupId,
                  @Nonnull
                  String name,
                  @Nullable
                  VersionRange range)

Creates a new dependency reference.

Parameters:

groupId - group id

name - name

range - version range

Dependency

public Dependency(@Nonnull
                  PackageId id)

Creates a new dependency to the specified package id

Parameters:

id - package id.

Method Detail

getGroup

@Nonnull
public String getGroup()

Returns the group of the dependency

Returns:

the group id

Since:

2.4

getName

@Nonnull
public String getName()

Returns the name of the dependency

Returns:

the name

getRange

@Nonnull
public VersionRange getRange()

Returns the version range

Returns:

the version range

getPath

@Deprecated
@Nonnull
public String getPath()

Deprecated.

As of 3.1.42, the storage location is implementation details.

Returns the installation path of this dependency

Returns:

the installation path;

matches

public boolean matches(@Nonnull
                       PackageId id)

Checks if the given package id matches this dependency specification.

Parameters:

id - the package id

Returns:

true if matches

fromString

@Nullable
public static Dependency fromString(@Nullable
                                    String str)

Returns a dependency from a string. if the given id is null or an empty string, null is returned.

Parameters:

str - the string

Returns:

the dependency

parse

@Nonnull
public static Dependency[] parse(@Nonnull
                                 String str)

Parses a string serialization of dependency references generated by toString(Dependency...))}

Parameters:

str - serialized string

Returns:

array of dependency references

fromString

@Nonnull
public static Dependency[] fromString(@Nonnull
                                      String... str)

Returns dependencies from the given strings.

Parameters:

str - the strings

Returns:

the dependencies

toString

@Nonnull
public static String toString(@Nonnull
                              Dependency... deps)

Returns a string representation from given dependencies.

Parameters:

deps - the dependencies

Returns:

the strings

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object