PackageURL (Package URL 1.5.0 API)

java.lang.Object
- com.github.packageurl.PackageURL

All Implemented Interfaces:

Serializable
```
public final class PackageURL
extends Object
implements Serializable
```
Package-URL (aka purl) is a "mostly universal" URL to describe a package. A purl is a URL composed of seven components:
```
 scheme:type/namespace/name@version?qualifiers#subpath
 
```
Components are separated by a specific character for unambiguous parsing. A purl must NOT contain a URL Authority i.e. there is no support for username, password, host and port components. A namespace segment may sometimes look like a host but its interpretation is specific to a type.

SPEC: https://github.com/package-url/purl-spec
Since:

1.0.0

Author:

Steve Springett

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PackageURL.StandardTypes
Convenience constants that defines common Package-URL 'type's.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PackageURL.StandardTypes` Convenience constants that defines common Package-URL 'type's.

Constructor Summary

Constructors
Constructor and Description
`PackageURL(String purl)` Constructs a new PackageURL object by parsing the specified string.
`PackageURL(String type, String name)` Constructs a new PackageURL object by specifying only the required parameters necessary to create a valid PackageURL.
`PackageURL(String type, String namespace, String name, String version, TreeMap<String,String> qualifiers, String subpath)` Constructs a new PackageURL object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`canonicalize()` Returns the canonicalized representation of the purl.
`boolean`	`equals(Object o)`
`String`	`getCoordinates()` Returns only the canonicalized coordinates of the Package URL which includes the type, namespace, name, and version, and which omits the qualifier and subpath.
`String`	`getName()` Returns the name of the package.
`String`	`getNamespace()` Returns the name prefix such as a Maven groupid, a Docker image owner, a GitHub user or organization.
`Map<String,String>`	`getQualifiers()` Returns extra qualifying data for a package such as an OS, architecture, a distro, etc.
`String`	`getScheme()` Returns the package url scheme.
`String`	`getSubpath()` Returns extra subpath within a package, relative to the package root.
`String`	`getType()` Returns the package "type" or package "protocol" such as maven, npm, nuget, gem, pypi, etc.
`String`	`getVersion()` Returns the version of the package.
`int`	`hashCode()`
`boolean`	`isBaseEquals(PackageURL purl)` Deprecated. This method is no longer recommended and will be removed from a future release. Use `isCoordinatesEquals(com.github.packageurl.PackageURL)` instead.
`boolean`	`isCanonicalEquals(PackageURL purl)` Evaluates if the specified Package URL has the same canonical value.
`boolean`	`isCoordinatesEquals(PackageURL purl)` Evaluates if the specified Package URL has the same values up to, but excluding the qualifier (querystring).
`PackageURLBuilder`	`toBuilder()`
`String`	`toString()` Returns the canonicalized representation of the purl.
`static String`	`uriDecode(String source)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PackageURL
```
public PackageURL(String purl)
           throws MalformedPackageURLException
```
    Constructs a new PackageURL object by parsing the specified string.
    
    Parameters:
    
    purl - a valid package URL string to parse
    
    Throws:
    
    MalformedPackageURLException - if parsing fails
    
    Since:
    
    1.0.0
  - PackageURL
```
public PackageURL(String type,
                  String name)
           throws MalformedPackageURLException
```
    Constructs a new PackageURL object by specifying only the required parameters necessary to create a valid PackageURL.
    
    Parameters:
    
    type - the type of package (i.e. maven, npm, gem, etc)
    
    name - the name of the package
    
    Throws:
    
    MalformedPackageURLException - if parsing fails
    
    Since:
    
    1.0.0
  - PackageURL
```
public PackageURL(String type,
                  String namespace,
                  String name,
                  String version,
                  TreeMap<String,String> qualifiers,
                  String subpath)
           throws MalformedPackageURLException
```
    Constructs a new PackageURL object.
    
    Parameters:
    
    type - the type of package (i.e. maven, npm, gem, etc)
    
    namespace - the name prefix (i.e. group, owner, organization)
    
    name - the name of the package
    
    version - the version of the package
    
    qualifiers - an array of key/value pair qualifiers
    
    subpath - the subpath string
    
    Throws:
    
    MalformedPackageURLException - if parsing fails
    
    Since:
    
    1.0.0
- Method Detail
  - toBuilder
```
public PackageURLBuilder toBuilder()
```
  - getScheme
```
public String getScheme()
```
    Returns the package url scheme.
    
    Returns:
    
    the scheme
    
    Since:
    
    1.0.0
  - getType
```
public String getType()
```
    Returns the package "type" or package "protocol" such as maven, npm, nuget, gem, pypi, etc.
    
    Returns:
    
    the type
    
    Since:
    
    1.0.0
  - getNamespace
```
public String getNamespace()
```
    Returns the name prefix such as a Maven groupid, a Docker image owner, a GitHub user or organization.
    
    Returns:
    
    the namespace
    
    Since:
    
    1.0.0
  - getName
```
public String getName()
```
    Returns the name of the package.
    
    Returns:
    
    the name of the package
    
    Since:
    
    1.0.0
  - getVersion
```
public String getVersion()
```
    Returns the version of the package.
    
    Returns:
    
    the version of the package
    
    Since:
    
    1.0.0
  - getQualifiers
```
public Map<String,String> getQualifiers()
```
    Returns extra qualifying data for a package such as an OS, architecture, a distro, etc. This method returns an UnmodifiableMap.
    
    Returns:
    
    qualifiers
    
    Since:
    
    1.0.0
  - getSubpath
```
public String getSubpath()
```
    Returns extra subpath within a package, relative to the package root.
    
    Returns:
    
    the subpath
    
    Since:
    
    1.0.0
  - toString
```
public String toString()
```
    Returns the canonicalized representation of the purl.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the canonicalized representation of the purl
    
    Since:
    
    1.1.0
  - canonicalize
```
public String canonicalize()
```
    Returns the canonicalized representation of the purl.
    
    Returns:
    
    the canonicalized representation of the purl
    
    Since:
    
    1.0.0
  - uriDecode
```
public static String uriDecode(String source)
```
  - isBaseEquals
```
@Deprecated
public boolean isBaseEquals(PackageURL purl)
```
    Deprecated. This method is no longer recommended and will be removed from a future release.
    Use isCoordinatesEquals(com.github.packageurl.PackageURL) instead.
    
    Evaluates if the specified Package URL has the same values up to, but excluding the qualifier (querystring). This includes equivalence of: scheme, type, namespace, name, and version, but excludes qualifier and subpath from evaluation.
    
    Parameters:
    
    purl - the Package URL to evaluate
    
    Returns:
    
    true if equivalence passes, false if not
    
    Since:
    
    1.2.0
  - isCoordinatesEquals
```
public boolean isCoordinatesEquals(PackageURL purl)
```
    Evaluates if the specified Package URL has the same values up to, but excluding the qualifier (querystring). This includes equivalence of: scheme, type, namespace, name, and version, but excludes qualifier and subpath from evaluation.
    
    Parameters:
    
    purl - the Package URL to evaluate
    
    Returns:
    
    true if equivalence passes, false if not
    
    Since:
    
    1.4.0
  - getCoordinates
```
public String getCoordinates()
```
    Returns only the canonicalized coordinates of the Package URL which includes the type, namespace, name, and version, and which omits the qualifier and subpath.
    
    Returns:
    
    A canonicalized PackageURL String excluding the qualifier and subpath.
    
    Since:
    
    1.4.0
  - isCanonicalEquals
```
public boolean isCanonicalEquals(PackageURL purl)
```
    Evaluates if the specified Package URL has the same canonical value. This method canonicalizes the Package URLs being evaluated and performs an equivalence on the canonical values. Canonical equivalence is especially useful for qualifiers, which can be in any order, but have a predictable order in canonicalized form.
    
    Parameters:
    
    purl - the Package URL to evaluate
    
    Returns:
    
    true if equivalence passes, false if not
    
    Since:
    
    1.2.0
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class PackageURL

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PackageURL

PackageURL

PackageURL

Method Detail

toBuilder

getScheme

getType

getNamespace

getName

getVersion

getQualifiers

getSubpath

toString

canonicalize

uriDecode

isBaseEquals

isCoordinatesEquals

getCoordinates

isCanonicalEquals

equals

hashCode