gov.nist.secauto.swid.builder.resource.file

Class FileBuilder

java.lang.Object

gov.nist.secauto.swid.builder.AbstractBuilder

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

gov.nist.secauto.swid.builder.resource.AbstractResourceBuilder<E>

gov.nist.secauto.swid.builder.resource.file.AbstractFileSystemItemBuilder<FileBuilder>

gov.nist.secauto.swid.builder.resource.file.FileBuilder

All Implemented Interfaces:

Builder, ResourceBuilder

public class FileBuilder
extends AbstractFileSystemItemBuilder<FileBuilder>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileBuilder()

Method Summary

Modifier and Type	Method and Description
<T> void	accept(T parentContext, ResourceCollectionEntryGenerator<T> creator)
static FileBuilder	create()
Map<HashAlgorithm,byte[]>	getHashAlgorithmToValueMap()
Long	getSize()
String	getVersion()
FileBuilder	hash(HashAlgorithm algorithm, byte[] hashBytes) Sets the file's hash value, for the provided algorithm, to the provided value.
FileBuilder	hash(HashAlgorithm algorithm, File file) Sets the to-be-built file's hash value, for the provided algorithm, to the provided value.
FileBuilder	hash(HashAlgorithm algorithm, InputStream is) Sets the file's hash value, for the provided algorithm, to the provided value.
FileBuilder	hash(HashAlgorithm algorithm, String hashHexBytes) Sets the file's hash value, for the provided algorithm, to the provided value.
void	reset()
FileBuilder	size(long size) Sets the to-be-built file's size to the provided value.
FileBuilder	version(String version) Sets the to-be-built file's version to the provided value.

Methods inherited from class gov.nist.secauto.swid.builder.resource.file.AbstractFileSystemItemBuilder

getKey, getLocation, getName, getRoot, location, name, nameAndLocation, root, 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

Methods inherited from interface gov.nist.secauto.swid.builder.Builder

isValid

Constructor Detail

FileBuilder

protected FileBuilder()

Method Detail

reset

public void reset()

Specified by:

reset in interface Builder

Overrides:

reset in class AbstractFileSystemItemBuilder<FileBuilder>

create

public static FileBuilder create()

accept

public <T> void accept(T parentContext,
                       ResourceCollectionEntryGenerator<T> creator)

getSize

public Long getSize()

getVersion

public String getVersion()

getHashAlgorithmToValueMap

public Map<HashAlgorithm,byte[]> getHashAlgorithmToValueMap()

size

public FileBuilder size(long size)

Sets the to-be-built file's size to the provided value.

Parameters:

size - a non-zero integer indicating the file's size in bytes

Returns:

the same builder instance

hash

public FileBuilder hash(HashAlgorithm algorithm,
                        File file)
                 throws NoSuchAlgorithmException,
                        IOException

Sets the to-be-built file's hash value, for the provided algorithm, to the provided value. An InputStream is used to retrieve the files contents to calculate the hash value. The caller is resposnible for closing the stream used by this method.

Parameters:

algorithm - the algorithm to establish a hash value for

file - the file to hash

Returns:

the same builder instance

Throws:

NoSuchAlgorithmException - if the hash algorithm is not supported

IOException - if an error occurs while reading the stream

hash

public FileBuilder hash(HashAlgorithm algorithm,
                        InputStream is)
                 throws NoSuchAlgorithmException,
                        IOException

Sets the file's hash value, for the provided algorithm, to the provided value. An InputStream is used to retrieve the files contents to calculate the hash value. The caller is responsible for closing the stream used by this method.

Parameters:

algorithm - the algorithm to establish a hash value for

is - an InputStream that can be used to read the file

Returns:

the same builder instance

Throws:

NoSuchAlgorithmException - if the hash algorithm is not supported

IOException - if an error occurs while reading the stream

hash

public FileBuilder hash(HashAlgorithm algorithm,
                        byte[] hashBytes)

Sets the file's hash value, for the provided algorithm, to the provided value.

Parameters:

algorithm - the algorithm to establish a hash value for

hashBytes - the digest value as a byte array.

Returns:

the same builder instance

hash

public FileBuilder hash(HashAlgorithm algorithm,
                        String hashHexBytes)

Sets the file's hash value, for the provided algorithm, to the provided value.

Parameters:

algorithm - the algorithm to establish a hash value for

hashHexBytes - the digest value as a hex string.

Returns:

the same builder instance

version

public FileBuilder version(String version)

Sets the to-be-built file's version to the provided value.

Parameters:

version - the version value to use

Returns:

the same builder instance