Package org.pkl.core.project

Record Class Package

java.lang.Object
java.lang.Record
org.pkl.core.project.Package
public record Package(String name, PackageUri uri, Version version, URI packageZipUrl, @Nullable String description, List<String> authors, @Nullable URI website, @Nullable URI documentation, @Nullable URI sourceCode, @Nullable String sourceCodeUrlScheme, @Nullable String license, @Nullable String licenseText, @Nullable URI issueTracker, List<Path> apiTests, List<String> exclude) extends Record
Java representation of class pkl.Project#Package

  • Constructor Details

    • Package

      public Package(String name, PackageUri uri, Version version, URI packageZipUrl, @Nullable @Nullable String description, List<String> authors, @Nullable @Nullable URI website, @Nullable @Nullable URI documentation, @Nullable @Nullable URI sourceCode, @Nullable @Nullable String sourceCodeUrlScheme, @Nullable @Nullable String license, @Nullable @Nullable String licenseText, @Nullable @Nullable URI issueTracker, List<Path> apiTests, List<String> exclude)
      Creates an instance of a Package record class.
      Parameters:
      name - the value for the name record component
      uri - the value for the uri record component
      version - the value for the version record component
      packageZipUrl - the value for the packageZipUrl record component
      description - the value for the description record component
      authors - the value for the authors record component
      website - the value for the website record component
      documentation - the value for the documentation record component
      sourceCode - the value for the sourceCode record component
      sourceCodeUrlScheme - the value for the sourceCodeUrlScheme record component
      license - the value for the license record component
      licenseText - the value for the licenseText record component
      issueTracker - the value for the issueTracker record component
      apiTests - the value for the apiTests record component
      exclude - the value for the exclude record component

  • Method Details

    • getName

      @Deprecated(forRemoval=true) public String getName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by name().

    • getUri

      @Deprecated(forRemoval=true) public PackageUri getUri()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by uri().

    • getVersion

      @Deprecated(forRemoval=true) public Version getVersion()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by version().

    • getPackageZipUrl

      @Deprecated(forRemoval=true) public URI getPackageZipUrl()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by packageZipUrl().

    • getDescription

      @Deprecated(forRemoval=true) @Nullable public @Nullable String getDescription()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by description().

    • getAuthors

      @Deprecated(forRemoval=true) public List<String> getAuthors()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by authors().

    • getWebsite

      @Deprecated(forRemoval=true) @Nullable public @Nullable URI getWebsite()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by website().

    • getDocumentation

      @Deprecated(forRemoval=true) @Nullable public @Nullable URI getDocumentation()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by documentation().

    • getSourceCode

      @Deprecated(forRemoval=true) @Nullable public @Nullable URI getSourceCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by sourceCode().

    • getSourceCodeUrlScheme

      @Deprecated(forRemoval=true) @Nullable public @Nullable String getSourceCodeUrlScheme()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by sourceCodeUrlScheme().

    • getLicenseText

      @Deprecated(forRemoval=true) @Nullable public @Nullable String getLicenseText()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by licenseText().

    • getLicense

      @Deprecated(forRemoval=true) @Nullable public @Nullable String getLicense()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by license().

    • getIssueTracker

      @Deprecated(forRemoval=true) @Nullable public @Nullable URI getIssueTracker()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by issueTracker().

    • getApiTests

      @Deprecated(forRemoval=true) public List<Path> getApiTests()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by apiTests().

    • getExclude

      @Deprecated(forRemoval=true) public List<String> getExclude()
      Deprecated, for removal: This API element is subject to removal in a future version.
      As of 0.28.0, replaced by exclude().

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • uri

      public PackageUri uri()
      Returns the value of the uri record component.
      Returns:
      the value of the uri record component

    • version

      public Version version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component

    • packageZipUrl

      public URI packageZipUrl()
      Returns the value of the packageZipUrl record component.
      Returns:
      the value of the packageZipUrl record component

    • description

      @Nullable public @Nullable String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • authors

      public List<String> authors()
      Returns the value of the authors record component.
      Returns:
      the value of the authors record component

    • website

      @Nullable public @Nullable URI website()
      Returns the value of the website record component.
      Returns:
      the value of the website record component

    • documentation

      @Nullable public @Nullable URI documentation()
      Returns the value of the documentation record component.
      Returns:
      the value of the documentation record component

    • sourceCode

      @Nullable public @Nullable URI sourceCode()
      Returns the value of the sourceCode record component.
      Returns:
      the value of the sourceCode record component

    • sourceCodeUrlScheme

      @Nullable public @Nullable String sourceCodeUrlScheme()
      Returns the value of the sourceCodeUrlScheme record component.
      Returns:
      the value of the sourceCodeUrlScheme record component

    • license

      @Nullable public @Nullable String license()
      Returns the value of the license record component.
      Returns:
      the value of the license record component

    • licenseText

      @Nullable public @Nullable String licenseText()
      Returns the value of the licenseText record component.
      Returns:
      the value of the licenseText record component

    • issueTracker

      @Nullable public @Nullable URI issueTracker()
      Returns the value of the issueTracker record component.
      Returns:
      the value of the issueTracker record component

    • apiTests

      public List<Path> apiTests()
      Returns the value of the apiTests record component.
      Returns:
      the value of the apiTests record component

    • exclude

      public List<String> exclude()
      Returns the value of the exclude record component.
      Returns:
      the value of the exclude record component