A B C D E G H I M N P Q R S T U V W
All Classes All Packages

A

aPackageURL() - Static method in class com.github.packageurl.PackageURLBuilder

Obtain a reference to a new builder object.

B

BITBUCKET - Static variable in class com.github.packageurl.PackageURL.StandardTypes

build() - Method in class com.github.packageurl.PackageURLBuilder

Builds the new PackageURL object.

C

canonicalize() - Method in class com.github.packageurl.PackageURL

Returns the canonicalized representation of the purl.

canonicalize(boolean) - Method in class com.github.packageurl.PackageURL

Returns the canonicalized representation of the purl.

CARGO - Static variable in class com.github.packageurl.PackageURL.StandardTypes

com.github.packageurl - package com.github.packageurl

Java implementation of the Package-URL Specification.

com.github.packageurl.validator - package com.github.packageurl.validator

COMPOSER - Static variable in class com.github.packageurl.PackageURL.StandardTypes

D

DEBIAN - Static variable in class com.github.packageurl.PackageURL.StandardTypes

DOCKER - Static variable in class com.github.packageurl.PackageURL.StandardTypes

E

encodePath(String) - Method in class com.github.packageurl.PackageURL

equals(Object) - Method in class com.github.packageurl.PackageURL

G

GEM - Static variable in class com.github.packageurl.PackageURL.StandardTypes

GENERIC - Static variable in class com.github.packageurl.PackageURL.StandardTypes

getCoordinates() - Method in class com.github.packageurl.PackageURL

Returns only the canonicalized coordinates of the Package URL which includes the type, namespace, name, and version, and which omits the qualifier and subpath.

getName() - Method in class com.github.packageurl.PackageURL

Returns the name of the package.

getName() - Method in class com.github.packageurl.PackageURLBuilder

Returns current name value set in the builder.

getNamespace() - Method in class com.github.packageurl.PackageURL

Returns the name prefix such as a Maven groupid, a Docker image owner, a GitHub user or organization.

getNamespace() - Method in class com.github.packageurl.PackageURLBuilder

Returns current namespace value set in the builder.

getQualifier(String) - Method in class com.github.packageurl.PackageURLBuilder

Returns a currently set qualifier value set in the builder for the specified key.

getQualifiers() - Method in class com.github.packageurl.PackageURL

Returns extra qualifying data for a package such as an OS, architecture, a distro, etc.

getQualifiers() - Method in class com.github.packageurl.PackageURLBuilder

Returns sorted map containing all qualifiers set in this builder.

getScheme() - Method in class com.github.packageurl.PackageURL

Returns the package url scheme.

getSubpath() - Method in class com.github.packageurl.PackageURL

Returns extra subpath within a package, relative to the package root.

getSubpath() - Method in class com.github.packageurl.PackageURLBuilder

Returns current subpath value set in the builder.

getType() - Method in class com.github.packageurl.PackageURL

Returns the package "type" or package "protocol" such as maven, npm, nuget, gem, pypi, etc.

getType() - Method in class com.github.packageurl.PackageURLBuilder

Returns current type value set in the builder.

getVersion() - Method in class com.github.packageurl.PackageURL

Returns the version of the package.

getVersion() - Method in class com.github.packageurl.PackageURLBuilder

Returns current version value set in the builder.

GITHUB - Static variable in class com.github.packageurl.PackageURL.StandardTypes

GOLANG - Static variable in class com.github.packageurl.PackageURL.StandardTypes

groups() - Method in annotation type com.github.packageurl.validator.PackageURL

H

hashCode() - Method in class com.github.packageurl.PackageURL

HEX - Static variable in class com.github.packageurl.PackageURL.StandardTypes

I

isAlpha(int) - Static method in class com.github.packageurl.PackageURL

isBaseEquals(PackageURL) - Method in class com.github.packageurl.PackageURL

Deprecated.

This method is no longer recommended and will be removed from a future release.

Use PackageURL.isCoordinatesEquals(com.github.packageurl.PackageURL) instead.

isCanonicalEquals(PackageURL) - Method in class com.github.packageurl.PackageURL

Evaluates if the specified Package URL has the same canonical value.

isCoordinatesEquals(PackageURL) - Method in class com.github.packageurl.PackageURL

Evaluates if the specified Package URL has the same values up to, but excluding the qualifier (querystring).

isDigit(int) - Static method in class com.github.packageurl.PackageURL

isUnreserved(int) - Static method in class com.github.packageurl.PackageURL

isValid(String, ConstraintValidatorContext) - Method in class com.github.packageurl.validator.PackageURLConstraintValidator

M

MalformedPackageURLException - Exception in com.github.packageurl

Exception class intended to be used for PackageURL parsing exceptions.

MalformedPackageURLException() - Constructor for exception com.github.packageurl.MalformedPackageURLException

Constructs a MalformedPackageURLException with no detail message.

MalformedPackageURLException(String) - Constructor for exception com.github.packageurl.MalformedPackageURLException

Constructs a MalformedPackageURLException with the specified detail message.

MAVEN - Static variable in class com.github.packageurl.PackageURL.StandardTypes

message() - Method in annotation type com.github.packageurl.validator.PackageURL

N

name - Variable in class com.github.packageurl.PackageURL

The name of the package.

name - Variable in class com.github.packageurl.PackageURLBuilder

namespace - Variable in class com.github.packageurl.PackageURL

The name prefix such as a Maven groupid, a Docker image owner, a GitHub user or organization.

namespace - Variable in class com.github.packageurl.PackageURLBuilder

NPM - Static variable in class com.github.packageurl.PackageURL.StandardTypes

NUGET - Static variable in class com.github.packageurl.PackageURL.StandardTypes

P

PackageURL - Class in com.github.packageurl

Package-URL (aka purl) is a "mostly universal" URL to describe a package.

PackageURL - Annotation Type in com.github.packageurl.validator

Annotation that can be applied to a String field within a class.

PackageURL(String) - Constructor for class com.github.packageurl.PackageURL

Constructs a new PackageURL object by parsing the specified string.

PackageURL(String, String) - Constructor for class com.github.packageurl.PackageURL

Constructs a new PackageURL object by specifying only the required parameters necessary to create a valid PackageURL.

PackageURL(String, String, String, String, TreeMap<String, String>, String) - Constructor for class com.github.packageurl.PackageURL

Constructs a new PackageURL object.

PackageURL.StandardTypes - Class in com.github.packageurl

Convenience constants that defines common Package-URL 'type's.

PackageURLBuilder - Class in com.github.packageurl

A builder construct for Package-URL objects.

PackageURLBuilder() - Constructor for class com.github.packageurl.PackageURLBuilder

PackageURLConstraintValidator - Class in com.github.packageurl.validator

A JSR-303 compliant validator that validates String fields conform to the Package URL specification.

PackageURLConstraintValidator() - Constructor for class com.github.packageurl.validator.PackageURLConstraintValidator

parse(String) - Method in class com.github.packageurl.PackageURL

Given a specified PackageURL, this method will parse the purl and populate this classes instance fields so that the corresponding getters may be called to retrieve the individual pieces of the purl.

parsePath(String, boolean) - Method in class com.github.packageurl.PackageURL

parseQualifiers(String) - Method in class com.github.packageurl.PackageURL

PATH_SPLITTER - Static variable in class com.github.packageurl.PackageURL

payload() - Method in annotation type com.github.packageurl.validator.PackageURL

percentDecode(String) - Method in class com.github.packageurl.PackageURL

Optionally decodes a String, if it's encoded.

percentEncode(String) - Method in class com.github.packageurl.PackageURL

Encodes the input in conformance with RFC 3986.

PYPI - Static variable in class com.github.packageurl.PackageURL.StandardTypes

Q

qualifiers - Variable in class com.github.packageurl.PackageURL

Extra qualifying data for a package such as an OS, architecture, a distro, etc.

qualifiers - Variable in class com.github.packageurl.PackageURLBuilder

R

RPM - Static variable in class com.github.packageurl.PackageURL.StandardTypes

S

scheme - Variable in class com.github.packageurl.PackageURL

The PackageURL scheme constant

serialVersionUID - Static variable in exception com.github.packageurl.MalformedPackageURLException

serialVersionUID - Static variable in class com.github.packageurl.PackageURL

serialVersionUID - Static variable in exception com.github.packageurl.ValidationException

StandardTypes() - Constructor for class com.github.packageurl.PackageURL.StandardTypes

subpath - Variable in class com.github.packageurl.PackageURL

Extra subpath within a package, relative to the package root.

subpath - Variable in class com.github.packageurl.PackageURLBuilder

T

toBuilder() - Method in class com.github.packageurl.PackageURL

toString() - Method in class com.github.packageurl.PackageURL

Returns the canonicalized representation of the purl.

type - Variable in class com.github.packageurl.PackageURL

The package "type" or package "protocol" such as maven, npm, nuget, gem, pypi, etc.

type - Variable in class com.github.packageurl.PackageURLBuilder

U

uriDecode(String) - Static method in class com.github.packageurl.PackageURL

uriEncode(String, Charset) - Static method in class com.github.packageurl.PackageURL

V

validateKey(String) - Method in class com.github.packageurl.PackageURL

validateName(String) - Method in class com.github.packageurl.PackageURL

validateNamespace(String) - Method in class com.github.packageurl.PackageURL

validateNamespace(String[]) - Method in class com.github.packageurl.PackageURL

validatePath(String[], boolean) - Method in class com.github.packageurl.PackageURL

validatePath(String, boolean) - Method in class com.github.packageurl.PackageURL

validateQualifiers(Map<String, String>) - Method in class com.github.packageurl.PackageURL

validateScheme(String) - Method in class com.github.packageurl.PackageURL

validateType(String) - Method in class com.github.packageurl.PackageURL

validateVersion(String) - Method in class com.github.packageurl.PackageURL

ValidationException - Exception in com.github.packageurl

Internal exception class intended to be used within validation contained in lambda expressions.

ValidationException(String) - Constructor for exception com.github.packageurl.ValidationException

Constructs a ValidationException.

verifyTypeConstraints(String, String, String) - Method in class com.github.packageurl.PackageURL

Some purl types may have specific constraints.

version - Variable in class com.github.packageurl.PackageURL

The version of the package.

version - Variable in class com.github.packageurl.PackageURLBuilder

W

withName(String) - Method in class com.github.packageurl.PackageURLBuilder

Adds the package name.

withNamespace(String) - Method in class com.github.packageurl.PackageURLBuilder

Adds the package namespace.

withNoQualifiers() - Method in class com.github.packageurl.PackageURLBuilder

Removes all qualifiers, if any.

withoutQualifier(String) - Method in class com.github.packageurl.PackageURLBuilder

Removes a package qualifier.

withQualifier(String, String) - Method in class com.github.packageurl.PackageURLBuilder

Adds a package qualifier.

withSubpath(String) - Method in class com.github.packageurl.PackageURLBuilder

Adds the package subpath.

withType(String) - Method in class com.github.packageurl.PackageURLBuilder

Adds the package URL type.

withVersion(String) - Method in class com.github.packageurl.PackageURLBuilder

Adds the package version.

A B C D E G H I M N P Q R S T U V W
All Classes All Packages