JkDependency

All Known Subinterfaces:

JkFileDependency, JkTransitivityDependency

All Known Implementing Classes:

JkComputedDependency, JkCoordinateDependency, JkFileSystemDependency, JkLocalProjectDependency
```
public interface JkDependency
```
Interface standing for a dependency. It can be either :
- An external module as org.hibernate:hibernate-core:3.0.1
- A project inside a multi-project build
- Some files on the file system
- A process that produces 0 or n files

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`java.nio.file.Path`	`getIdeProjectDir()` In the IDE, a dependency can be provided by a project exporting it.
`static boolean`	`isCoordinate(java.lang.String pathOrCoordinate)` Determines whether the given String represents a coordinate or a file path.
`default boolean`	`matches(JkDependency other)` Returns `true` if the specified dependency matches with this one.
`static JkDependency`	`of(java.nio.file.Path baseDir, java.lang.String pathOrCoordinate)` Same as `of(String)` but resolve relative paths against the specified base directory.
`static JkDependency`	`of(java.lang.String pathOrCoordinate)` Returns either a `JkCoordinateDependency` or a `JkFileSystemDependency` depending on the specified parameter stands for a path or a coordinate.
`JkDependency`	`withIdeProjectDir(java.nio.file.Path path)` Returns a dependency identical to this one but with the specified project base dir.

- Method Detail
  - getIdeProjectDir
```
java.nio.file.Path getIdeProjectDir()
```
    In the IDE, a dependency can be provided by a project exporting it. When generating IDE metadata files (.classpath, xxx.iml), it's preferable to mention only the project exporting it rather than dependency itself. This method simply returns null when the dependency is not coming from another project.
  - withIdeProjectDir
```
JkDependency withIdeProjectDir(java.nio.file.Path path)
```
    Returns a dependency identical to this one but with the specified project base dir.
    
    See Also:
    
    getIdeProjectDir()
  - matches
```
default boolean matches(JkDependency other)
```
    Returns true if the specified dependency matches with this one.
    Matching means that two matching dependencies can not be declared in a same dependency set as it will be considered as a duplicate or result in a conflict.
    For example "com.google:guava:21.0" is matching with "com.google:guava:23.0" even if they are not equals.
  - of
```
static JkDependency of(java.lang.String pathOrCoordinate)
```
    Returns either a JkCoordinateDependency or a JkFileSystemDependency depending on the specified parameter stands for a path or a coordinate.
  - of
```
static JkDependency of(java.nio.file.Path baseDir,
                       java.lang.String pathOrCoordinate)
```
    Same as of(String) but resolve relative paths against the specified base directory.
  - isCoordinate
```
static boolean isCoordinate(java.lang.String pathOrCoordinate)
```
    Determines whether the given String represents a coordinate or a file path.

Interface JkDependency

Method Summary

Method Detail

getIdeProjectDir

withIdeProjectDir

matches

of

of

isCoordinate