Package org.pkl.core.packages

Class DependencyMetadata

java.lang.Object

org.pkl.core.packages.DependencyMetadata

public class DependencyMetadata
extends java.lang.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"
           }
         }
       }
     }
   
 

Constructor Summary

Constructors

Constructor

Description

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

Method Summary

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

DependencyMetadata

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

Method Detail

parse

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

Throws:

Json.JsonParseException

parseChecksums

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

Throws:

Json.JsonParseException

parseAuthors

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

Throws:

Json.JsonParseException

getName

public java.lang.String getName()

getVersion

public Version getVersion()

getPackageZipUrl

public java.net.URI getPackageZipUrl()

getPackageZipChecksums

public Checksums getPackageZipChecksums()

getDependencies

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

getSourceCodeUrlScheme

public @Nullable java.lang.String getSourceCodeUrlScheme()

getSourceCode

public @Nullable java.net.URI getSourceCode()

getDocumentation

public @Nullable java.net.URI getDocumentation()

getLicense

public @Nullable java.lang.String getLicense()

getLicenseText

public @Nullable java.lang.String getLicenseText()

getAuthors

public @Nullable java.util.List<java.lang.String> getAuthors()

getIssueTracker

public @Nullable java.net.URI getIssueTracker()

getDescription

public @Nullable java.lang.String getDescription()

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.IOException

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

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object