Package org.pkl.core.packages

Class DependencyMetadata

java.lang.Object

org.pkl.core.packages.DependencyMetadata

public final class DependencyMetadata
extends Object

Java representation of a package's dependency metadata.

Sample metadata:

   
     {
       "name": "my-proj-name",
       "packageUri": "package://example.com/my-proj-name@0.5.3",
       "version": "0.5.3",
       "packageZipChecksums": {
         "sha256": "abc123",
       }
       "packageZipUrl": "https://example.com/foo/bar@0.5.3.zip",
       "sourceCodeUrlScheme": "https://github.com/foo/bar/blob/v0.5.3/%{path}#L%{line}-L%{endLine}",
       "documentation": "https://my/docs",
       "description": "The description for my package",
       "issueTracker": "https://example.com/my/issues",
       "sourceCode": "https://github.com/foo/bar",
       "license": "Apache-2",
       "dependencies": {
         "foo": {
           "uri": "package://example.com/foo@0.5.3",
           "checksums": {
             "sha256": "abc123"
           }
         }
       },
       "annotations": [
         {
           "moduleName": "pkl.base",
           "class": "Unlisted",
           "moduleUri": "pkl:base",
           "properties": {}
         },
         {
           "moduleName": "pkl.base",
           "class": "Deprecated",
           "moduleUri": "pkl:base",
           "properties": {
             "since": "0.26.1",
             "message": "don't use",
             "replaceWith": null
           }
         }
       ]
     }
   
 

Constructor Summary

Constructors

Constructor

Description

DependencyMetadata(String name, PackageUri packageUri, Version version, URI packageZipUrl, Checksums packageZipChecksums, Map<String,Dependency.RemoteDependency> dependencies, @Nullable String sourceCodeUrlScheme, @Nullable URI sourceCode, @Nullable URI documentation, @Nullable String license, @Nullable String licenseText, @Nullable List<String> authors, @Nullable URI issueTracker, @Nullable String description, List<PObject> annotations)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<PObject>	getAnnotations()
@Nullable List<String>	getAuthors()
Map<String,Dependency.RemoteDependency>	getDependencies()
@Nullable String	getDescription()
@Nullable URI	getDocumentation()
@Nullable URI	getIssueTracker()
@Nullable String	getLicense()
@Nullable String	getLicenseText()
String	getName()
Checksums	getPackageZipChecksums()
URI	getPackageZipUrl()
@Nullable URI	getSourceCode()
@Nullable String	getSourceCodeUrlScheme()
Version	getVersion()
int	hashCode()
static DependencyMetadata	parse(String input)
static List<String>	parseAuthors(Object obj)
static Checksums	parseChecksums(Object obj)
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

DependencyMetadata

public DependencyMetadata(String name,
 PackageUri packageUri,
 Version version,
 URI packageZipUrl,
 Checksums packageZipChecksums,
 Map<String,Dependency.RemoteDependency> dependencies,
 @Nullable
 @Nullable String sourceCodeUrlScheme,
 @Nullable
 @Nullable URI sourceCode,
 @Nullable
 @Nullable URI documentation,
 @Nullable
 @Nullable String license,
 @Nullable
 @Nullable String licenseText,
 @Nullable
 @Nullable List<String> authors,
 @Nullable
 @Nullable URI issueTracker,
 @Nullable
 @Nullable String description,
 List<PObject> annotations)

Method Details

parse

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

Throws:

Json.JsonParseException

parseChecksums

public static Checksums parseChecksums(Object obj)
                                throws Json.JsonParseException

Throws:

Json.JsonParseException

parseAuthors

public static List<String> parseAuthors(Object obj)
                                 throws Json.JsonParseException

Throws:

Json.JsonParseException

getName

public String getName()

getVersion

public Version getVersion()

getPackageZipUrl

public URI getPackageZipUrl()

getPackageZipChecksums

public Checksums getPackageZipChecksums()

getDependencies

public Map<String,Dependency.RemoteDependency> getDependencies()

getSourceCodeUrlScheme

@Nullable
public @Nullable String getSourceCodeUrlScheme()

getSourceCode

@Nullable
public @Nullable URI getSourceCode()

getDocumentation

@Nullable
public @Nullable URI getDocumentation()

getLicense

@Nullable
public @Nullable String getLicense()

getLicenseText

@Nullable
public @Nullable String getLicenseText()

getAuthors

@Nullable
public @Nullable List<String> getAuthors()

getIssueTracker

@Nullable
public @Nullable URI getIssueTracker()

getDescription

@Nullable
public @Nullable String getDescription()

getAnnotations

public List<PObject> getAnnotations()

writeTo

public void writeTo(OutputStream out)
             throws IOException

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

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object