com.github.packageurl

Class PackageURLBuilder

java.lang.Object

com.github.packageurl.PackageURLBuilder

public final class PackageURLBuilder
extends Object

A builder construct for Package-URL objects.

Method Summary

Modifier and Type	Method and Description
static PackageURLBuilder	aPackageURL() Obtain a reference to a new builder object.
PackageURL	build() Builds the new PackageURL object.
PackageURLBuilder	withName(String name) Adds the package name.
PackageURLBuilder	withNamespace(String namespace) Adds the package namespace.
PackageURLBuilder	withQualifier(String key, String value) Adds a package qualifier.
PackageURLBuilder	withSubpath(String subpath) Adds the package subpath.
PackageURLBuilder	withType(String type) Adds the package URL type.
PackageURLBuilder	withVersion(String version) Adds the package version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

aPackageURL

public static PackageURLBuilder aPackageURL()

Obtain a reference to a new builder object.

Returns:

a new builder object.

withType

public PackageURLBuilder withType(String type)

Adds the package URL type.

Parameters:

type - the package type

Returns:

a reference to the builder

See Also:

PackageURL.getName(), PackageURL.StandardTypes

withNamespace

public PackageURLBuilder withNamespace(String namespace)

Adds the package namespace.

Parameters:

namespace - the package namespace

Returns:

a reference to the builder

See Also:

PackageURL.getNamespace()

withName

public PackageURLBuilder withName(String name)

Adds the package name.

Parameters:

name - the package name

Returns:

a reference to the builder

See Also:

PackageURL.getName()

withVersion

public PackageURLBuilder withVersion(String version)

Adds the package version.

Parameters:

version - the package version

Returns:

a reference to the builder

See Also:

PackageURL.getVersion()

withSubpath

public PackageURLBuilder withSubpath(String subpath)

Adds the package subpath.

Parameters:

subpath - the package subpath

Returns:

a reference to the builder

See Also:

PackageURL.getSubpath()

withQualifier

public PackageURLBuilder withQualifier(String key,
                                       String value)

Adds a package qualifier.

Parameters:

key - the package qualifier key

value - the package qualifier value

Returns:

a reference to the builder

See Also:

PackageURL.getQualifiers()

build

public PackageURL build()
                 throws MalformedPackageURLException

Builds the new PackageURL object.

Returns:

the new PackageURL object

Throws:

MalformedPackageURLException - thrown if the type or name has not been specified or if a field fails validation