gov.nist.secauto.swid.plugin.entry.resource

Class ResourceFileEntry

java.lang.Object

gov.nist.secauto.swid.plugin.entry.AbstractFileEntry

gov.nist.secauto.swid.plugin.entry.resource.ResourceFileEntry

All Implemented Interfaces:

FileEntry

public class ResourceFileEntry
extends AbstractFileEntry

Constructor Summary

Constructors

Constructor and Description
ResourceFileEntry(org.apache.maven.model.Resource resource, Path file) Construct a new File entry contained with a Maven resource folder.

Method Summary

Modifier and Type	Method and Description
Path	getBase() Retrieve the base of the file's path, which can be excluded.
InputStream	getInputStream() Retrieve an input stream that can be used to read the file.
protected String	getOutputBase()
Path	getPath() Retrieve the full path to the file.
Long	getSize() Retrieve the file's size.
String	getVersion() Retrieve the file's version.

Methods inherited from class gov.nist.secauto.swid.plugin.entry.AbstractFileEntry

asFileInfo, getOutputRelativePath, getRelativePath, getRelativePathSegements

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceFileEntry

public ResourceFileEntry(org.apache.maven.model.Resource resource,
                         Path file)

Construct a new File entry contained with a Maven resource folder.

Parameters:

resource - the containing Maven resource

file - the file for this entry

Method Detail

getBase

public Path getBase()

Description copied from class: AbstractFileEntry

Retrieve the base of the file's path, which can be excluded.

Specified by:

getBase in class AbstractFileEntry

Returns:

the base

getOutputBase

protected String getOutputBase()

Specified by:

getOutputBase in class AbstractFileEntry

getPath

public Path getPath()

Description copied from class: AbstractFileEntry

Retrieve the full path to the file.

Specified by:

getPath in interface FileEntry

Specified by:

getPath in class AbstractFileEntry

Returns:

the filePath

getInputStream

public InputStream getInputStream()
                           throws FileNotFoundException

Description copied from interface: FileEntry

Retrieve an input stream that can be used to read the file.

Returns:

an input stream

Throws:

FileNotFoundException - if the file does not exist

getVersion

public String getVersion()

Description copied from interface: FileEntry

Retrieve the file's version.

Returns:

the file's version or null if a version cannot be determined

getSize

public Long getSize()

Description copied from interface: FileEntry

Retrieve the file's size.

Returns:

the size in bytes