gov.nist.secauto.swid.builder

Class LinkBuilder

java.lang.Object

gov.nist.secauto.swid.builder.AbstractBuilder

gov.nist.secauto.swid.builder.AbstractLanguageSpecificBuilder<LinkBuilder>

gov.nist.secauto.swid.builder.LinkBuilder

All Implemented Interfaces:

Builder

public class LinkBuilder
extends AbstractLanguageSpecificBuilder<LinkBuilder>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LinkBuilder()

Method Summary

Modifier and Type	Method and Description
LinkBuilder	artifact(String artifact) For use with rel="installationmedia" to identify the canonical name for an installation media resource.
static LinkBuilder	create()
String	getArtifact()
URI	getHref()
String	getMedia()
String	getMediaType()
LinkOwnership	getOwnership()
String	getRel()
LinkUse	getUse()
LinkBuilder	href(URI uri) Sets the to-be-built link's href to the provided value.
LinkBuilder	media(String query) Sets the to-be-built link's media to the provided value.
LinkBuilder	mediaType(String mediaType) Provide the IANA MediaType for the resource targeted by the href attribute; this provides the consumer with knowledge of the format of the referenced resource.
LinkBuilder	ownership(LinkOwnership ownership) Sets the to-be-built link's ownership to the provided value.
LinkBuilder	rel(String rel) Sets the to-be-built link's rel to the provided value.
void	reset()
LinkBuilder	use(LinkUse use) Sets the to-be-built link's use to the provided value.
void	validate()

Methods inherited from class gov.nist.secauto.swid.builder.AbstractLanguageSpecificBuilder

getLanguage, language

Methods inherited from class gov.nist.secauto.swid.builder.AbstractBuilder

isValid, validateNonEmpty, validateNonEmpty, validateNonEmpty, validateNonEmpty, validateNonNull, validatePatternMatch

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkBuilder

protected LinkBuilder()

Method Detail

create

public static LinkBuilder create()

reset

public void reset()

Specified by:

reset in interface Builder

Overrides:

reset in class AbstractLanguageSpecificBuilder<LinkBuilder>

getArtifact

public String getArtifact()

getHref

public URI getHref()

getMedia

public String getMedia()

getOwnership

public LinkOwnership getOwnership()

getRel

public String getRel()

getMediaType

public String getMediaType()

getUse

public LinkUse getUse()

artifact

public LinkBuilder artifact(String artifact)

For use with rel="installationmedia" to identify the canonical name for an installation media resource.

Parameters:

artifact - a cononical name for the installation media

Returns:

the same builder instance

href

public LinkBuilder href(URI uri)

Sets the to-be-built link's href to the provided value.

Parameters:

uri - a URI identifying the linked resource

Returns:

the same builder instance

media

public LinkBuilder media(String query)

Sets the to-be-built link's media to the provided value.

Parameters:

query - a media query as defined by ISO/IEC 19770-2:2015

Returns:

the same builder instance

ownership

public LinkBuilder ownership(LinkOwnership ownership)

Sets the to-be-built link's ownership to the provided value.

Parameters:

ownership - a valid non-null enumeration value

Returns:

the same builder instance

rel

public LinkBuilder rel(String rel)

Sets the to-be-built link's rel to the provided value.

Parameters:

rel - the link relation type

Returns:

the same builder instance

mediaType

public LinkBuilder mediaType(String mediaType)

Provide the IANA MediaType for the resource targeted by the href attribute; this provides the consumer with knowledge of the format of the referenced resource. The The IANA Media Type Registry provides more details on possible values.

Parameters:

mediaType - a valid media type value

Returns:

the same builder instance

use

public LinkBuilder use(LinkUse use)

Sets the to-be-built link's use to the provided value.

Parameters:

use - a valid, non-null enumeration value

Returns:

the same builder instance

validate

public void validate()
              throws ValidationException

Specified by:

validate in interface Builder

Overrides:

validate in class AbstractLanguageSpecificBuilder<LinkBuilder>

Throws:

ValidationException