Package org.pkl.core.project

Class ProjectDeps

java.lang.Object

org.pkl.core.project.ProjectDeps

public final class ProjectDeps
extends Object

The Java representation of a project's resolved dependency list. Resolved dependencies are stored as JSON as a sibling file to PklProject. Each key in the JSON file records an entry for each dependency via its base URI, and the major version number.

A resolved dependency can either be local or remote. A remote dependency will have its checksums recorded, while a local dependency will point to the relative path of the project holding the dependency.

Sample structure:

 
 {
   "schemaVersion": 1,
   "resolvedDependencies": {
     "package://example.com/my/package@0": {
       "type": "remote",
       "uri": "projectpackage://example.com/my/package@0.5.0",
       "checksums": {
         "sha256": "abc123"
       }
     },
     "package://example.com/other/package@1": {
       "type": "local",
       "uri": "projectpackage://example.com/other/package@1.5.0",
       "path": "../sibling"
     }
   }
 }
 

Constructor Summary

Constructors

Constructor	Description
ProjectDeps(org.graalvm.collections.EconomicMap<CanonicalPackageUri,Dependency> resolvedDependencies)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@Nullable Dependency	get(CanonicalPackageUri canonicalPackageUri)	Given a declared dependency, return the resolved dependency.
int	hashCode()
static ProjectDeps	parse(String input)
static ProjectDeps	parse(Path path)
String	toString()
void	writeTo(OutputStream out)	Serializes project dependencies to JSON, and writes it to the provided output stream.

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectDeps

public ProjectDeps(org.graalvm.collections.EconomicMap<CanonicalPackageUri,Dependency> resolvedDependencies)

Method Details

parse

public static ProjectDeps parse(Path path)
                         throws IOException,
URISyntaxException,
Json.JsonParseException

Throws:

IOException

URISyntaxException

Json.JsonParseException

parse

public static ProjectDeps parse(String input)
                         throws Json.JsonParseException

Throws:

Json.JsonParseException

get

@Nullable
public @Nullable Dependency get(CanonicalPackageUri canonicalPackageUri)

Given a declared dependency, return the resolved dependency.

writeTo

public void writeTo(OutputStream out)
             throws IOException

Serializes project dependencies to JSON, and writes it to the provided output stream.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object