SWIDBuilder (SWID Tag Generation Java API 0.6.1 API)

java.lang.Object
- gov.nist.secauto.swid.builder.AbstractBuilder
- - gov.nist.secauto.swid.builder.AbstractLanguageSpecificBuilder<SWIDBuilder>
  - - gov.nist.secauto.swid.builder.SWIDBuilder

All Implemented Interfaces:: Builder

public class SWIDBuilder
extends AbstractLanguageSpecificBuilder<SWIDBuilder>

Constructor Summary

Constructors
Modifier Constructor and Description

protected SWIDBuilder()

Constructors
Modifier	Constructor and Description
`protected`	`SWIDBuilder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SWIDBuilder`	`addEntity(EntityBuilder entity)` Adds a new entity to the tag.
`SWIDBuilder`	`addLink(LinkBuilder link)` Adds a new link to the tag.
`SWIDBuilder`	`addMeta(MetaBuilder meta)` Adds a new meta to the tag.
`static SWIDBuilder`	`create()`
`SWIDBuilder`	`evidence(EvidenceBuilder evidence)` Adds a new evidence to the tag.
`List<EntityBuilder>`	`getEntities()`
`EvidenceBuilder`	`getEvidence()`
`List<LinkBuilder>`	`getLinks()`
`String`	`getMedia()`
`List<MetaBuilder>`	`getMetas()`
`String`	`getName()`
`PayloadBuilder`	`getPayload()`
`String`	`getTagId()`
`TagType`	`getTagType()`
`BigInteger`	`getTagVersion()`
`String`	`getVersion()`
`VersionScheme`	`getVersionScheme()`
`SWIDBuilder`	`media(String media)` Sets the to-be-built SWID tag's media to the provided value.
`SWIDBuilder`	`name(String name)` Sets the to-be-built tag's product name to the provided value.
`EvidenceBuilder`	`newEvidence()` Provide a new evidence node if a previous evidence node was not provided, or the cached node if one already exists.
`PayloadBuilder`	`newPayload()` Retrieves the existing PayloadBuilder or creates a new one if no PayloadBuilder has been created already.
`SWIDBuilder`	`payload(PayloadBuilder payload)` Adds a new payload to the tag.
`void`	`reset()`
`SWIDBuilder`	`tagId(String id)` Sets the to-be-built tag's product tag identifier to the provided value.
`SWIDBuilder`	`tagType(TagType type)` Sets the to-be-built tag's product type to the provided value.
`SWIDBuilder`	`tagVersion(BigInteger version)` Set the tag's tag version.
`SWIDBuilder`	`tagVersion(long version)`
`void`	`validate()`
`SWIDBuilder`	`version(String version)` Sets the to-be-built SWID tag's version to the provided value.
`SWIDBuilder`	`versionScheme(VersionScheme scheme)` Sets the to-be-built SWID tag's versionSchema to the provided value.

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
  - SWIDBuilder
```
protected SWIDBuilder()
```
- Method Detail
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface Builder
    
    Overrides:
    
    reset in class AbstractLanguageSpecificBuilder<SWIDBuilder>
  - create
```
public static SWIDBuilder create()
```
  - getTagId
```
public String getTagId()
```
  - getTagType
```
public TagType getTagType()
```
  - getName
```
public String getName()
```
  - getTagVersion
```
public BigInteger getTagVersion()
```
  - getVersion
```
public String getVersion()
```
  - getVersionScheme
```
public VersionScheme getVersionScheme()
```
  - getEntities
```
public List<EntityBuilder> getEntities()
```
  - getEvidence
```
public EvidenceBuilder getEvidence()
```
  - getPayload
```
public PayloadBuilder getPayload()
```
  - newEvidence
```
public EvidenceBuilder newEvidence()
```
    Provide a new evidence node if a previous evidence node was not provided, or the cached node if one already exists.
    
    Returns:
    
    the evidence node builder instance
  - getLinks
```
public List<LinkBuilder> getLinks()
```
  - getMetas
```
public List<MetaBuilder> getMetas()
```
  - newPayload
```
public PayloadBuilder newPayload()
```
    Retrieves the existing PayloadBuilder or creates a new one if no PayloadBuilder has been created already.
    
    Returns:
    
    the payload builder
  - getMedia
```
public String getMedia()
```
  - tagType
```
public SWIDBuilder tagType(TagType type)
```
    Sets the to-be-built tag's product type to the provided value.
    
    Parameters:
    
    type - the new type to set
    
    Returns:
    
    the same builder instance
  - name
```
public SWIDBuilder name(String name)
```
    Sets the to-be-built tag's product name to the provided value.
    
    Parameters:
    
    name - the name of the software product
    
    Returns:
    
    the same builder instance
  - tagId
```
public SWIDBuilder tagId(String id)
```
    Sets the to-be-built tag's product tag identifier to the provided value.
    
    Parameters:
    
    id - the tag identifier for the software product
    
    Returns:
    
    the same builder instance
  - tagVersion
```
public SWIDBuilder tagVersion(long version)
```
  - tagVersion
```
public SWIDBuilder tagVersion(BigInteger version)
```
    Set the tag's tag version.
    
    Parameters:
    
    version - the version value to use
    
    Returns:
    
    the same builder instance
  - version
```
public SWIDBuilder version(String version)
```
    Sets the to-be-built SWID tag's version to the provided value.
    
    Parameters:
    
    version - the version value to use
    
    Returns:
    
    the same builder instance
  - versionScheme
```
public SWIDBuilder versionScheme(VersionScheme scheme)
```
    Sets the to-be-built SWID tag's versionSchema to the provided value. The version scheme identifies the structure of the provided version.
    
    Parameters:
    
    scheme - the version scheme for the tag
    
    Returns:
    
    the same builder instance
    
    See Also:
    
    VersionScheme.lookupByIndex(int), VersionScheme.lookupByName(String), VersionScheme.assignPrivateVersionScheme(int, String), version(String)
  - media
```
public SWIDBuilder media(String media)
```
    Sets the to-be-built SWID tag's media to the provided value.
    
    Parameters:
    
    media - the media value to use
    
    Returns:
    
    the same builder instance
  - addEntity
```
public SWIDBuilder addEntity(EntityBuilder entity)
```
    Adds a new entity to the tag.
    
    Parameters:
    
    entity - a entity builder representing the new entity to add
    
    Returns:
    
    the same builder instance
  - addLink
```
public SWIDBuilder addLink(LinkBuilder link)
```
    Adds a new link to the tag.
    
    Parameters:
    
    link - a link builder representing the new link to add
    
    Returns:
    
    the same builder instance
  - addMeta
```
public SWIDBuilder addMeta(MetaBuilder meta)
```
    Adds a new meta to the tag.
    
    Parameters:
    
    meta - a meta builder representing the new meta to add
    
    Returns:
    
    the same builder instance
  - payload
```
public SWIDBuilder payload(PayloadBuilder payload)
```
    Adds a new payload to the tag.
    
    Parameters:
    
    payload - a payload builder representing the new payload to add
    
    Returns:
    
    the same builder instance
  - evidence
```
public SWIDBuilder evidence(EvidenceBuilder evidence)
```
    Adds a new evidence to the tag.
    
    Parameters:
    
    evidence - a evidence builder representing the new evidence to add
    
    Returns:
    
    the same builder instance
  - validate
```
public void validate()
              throws ValidationException
```
    Specified by:
    
    validate in interface Builder
    
    Overrides:
    
    validate in class AbstractLanguageSpecificBuilder<SWIDBuilder>
    
    Throws:
    
    ValidationException

Class SWIDBuilder

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

SWIDBuilder

Method Detail

reset

create

getTagId

getTagType

getName

getTagVersion

getVersion

getVersionScheme

getEntities

getEvidence

getPayload

newEvidence

getLinks

getMetas

newPayload

getMedia

tagType

name

tagId

tagVersion

tagVersion

version

versionScheme

media

addEntity

addLink

addMeta

payload

evidence

validate