Class FileMetadata

java.lang.Object

org.c02e.jpgpj.FileMetadata

public class FileMetadata
extends Object

Optional PGP message metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FileMetadata.Format	Format for line-ending normalization.
static class	FileMetadata.Signature	Signature found by decryptor.

Field Summary

Fields

Modifier and Type	Field	Description
static final FileMetadata.Format	DEFAULT_FORMAT
static final String	DEFAULT_NAME
private FileMetadata.Format	format
private long	lastModified
private long	length
private String	name
private final List<FileMetadata.Signature>	signatures
private final Ring	verified

Constructor Summary

Constructors

Constructor	Description
FileMetadata()	Constructs a metadata object with default values.
FileMetadata(File file)	Constructs a metadata object from a file.
FileMetadata(String name)	Constructs a metadata object with the specified file name .
FileMetadata(String name, FileMetadata.Format format)	Constructs a metadata object with the specified file name and line-ending format.
FileMetadata(String name, FileMetadata.Format format, long length, long lastModified)	Constructs a metadata object with the specified file name, line-ending format, length in bytes, and modified date in ms since the epoch.
FileMetadata(Path file)	Constructs a metadata object from a file.
FileMetadata(org.bouncycastle.openpgp.PGPLiteralData data)	Constructs a metadata object from Bouncy Castle message data.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
FileMetadata.Format	getFormat()
long	getLastModified()
Date	getLastModifiedDate()
long	getLength()
String	getName()
List<FileMetadata.Signature>	getSignatures()	Signatures found on the file, including unverified signatures.
int	getSignatureType()	PGP code for the signature type appropriate for the line-ending format of the original file.
Ring	getVerified()	Keys that signed the file with a verified signature.
int	hashCode()
void	setFile(File file)
void	setFile(Path file)
void	setFormat(FileMetadata.Format x)
void	setLastModified(long x)
void	setLength(long x)
void	setName(String x)
String	toString()
FileMetadata	withFile(File file)
FileMetadata	withFile(Path file)
FileMetadata	withFormat(FileMetadata.Format x)
FileMetadata	withLastModified(long x)
FileMetadata	withLength(long x)
FileMetadata	withName(String x)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_NAME

public static final String DEFAULT_NAME

See Also:

• Constant Field Values

DEFAULT_FORMAT

public static final FileMetadata.Format DEFAULT_FORMAT

name

private String name

format

private FileMetadata.Format format

length

private long length

lastModified

private long lastModified

signatures

private final List<FileMetadata.Signature> signatures

verified

private final Ring verified

Constructor Details

FileMetadata

public FileMetadata()

Constructs a metadata object with default values.

FileMetadata

public FileMetadata(org.bouncycastle.openpgp.PGPLiteralData data)

Constructs a metadata object from Bouncy Castle message data.

FileMetadata

public FileMetadata(File file)

Constructs a metadata object from a file.

FileMetadata

public FileMetadata(Path file)

Constructs a metadata object from a file.

FileMetadata

public FileMetadata(String name)

Constructs a metadata object with the specified file name .

FileMetadata

public FileMetadata(String name,
 FileMetadata.Format format)

Constructs a metadata object with the specified file name and line-ending format.

FileMetadata

public FileMetadata(String name,
 FileMetadata.Format format,
 long length,
 long lastModified)

Constructs a metadata object with the specified file name, line-ending format, length in bytes, and modified date in ms since the epoch.

Method Details

getName

public String getName()

Returns:

Original file name ("foo.txt"), or "".

setName

public void setName(String x)

Parameters:

x - Original file name ("foo.txt") - set to "" if null

withName

public FileMetadata withName(String x)

See Also:

• setName(String)

getLength

public long getLength()

Returns:

Original file length in bytes, or 0.

setLength

public void setLength(long x)

Parameters:

x - Original file length in bytes, or 0.

withLength

public FileMetadata withLength(long x)

See Also:

• setLength(long)

getLastModified

public long getLastModified()

Returns:

Original file modified date in ms since epoch, or 0.

setLastModified

public void setLastModified(long x)

Parameters:

x - Original file modified date in ms since epoch, or 0.

withLastModified

public FileMetadata withLastModified(long x)

See Also:

• setLastModified(long)

getLastModifiedDate

public Date getLastModifiedDate()

Returns:

Original file modified date, or date of the epoch.

See Also:

• getLastModified()
• setLastModified(long)
• withLastModified(long)

getFormat

public FileMetadata.Format getFormat()

Returns:

Original file format, or binary.

setFormat

public void setFormat(FileMetadata.Format x)

Parameters:

x - Original file format, or DEFAULT_FORMAT if null.

withFormat

public FileMetadata withFormat(FileMetadata.Format x)

See Also:

• setFormat(Format)

getVerified

public Ring getVerified()

Keys that signed the file with a verified signature. If a specific userid was included in a key's signature (such as "Alice <alice@example.com>"), it will be available via the key's Key.getSigningUid() method.

getSignatures

public List<FileMetadata.Signature> getSignatures()

Signatures found on the file, including unverified signatures.

setFile

public void setFile(File file)

Parameters:

file - Original File from which to extract the metadata - ignored if null Does not extract FileMetadata.Format metadata.

setFile

public void setFile(Path file)

Parameters:

file - Original Path from which to extract the metadata - ignored if null Does not extract FileMetadata.Format metadata.

withFile

public FileMetadata withFile(File file)

See Also:

• withFile(Path)

withFile

public FileMetadata withFile(Path file)

See Also:

• setFile(Path)

getSignatureType

public int getSignatureType()

PGP code for the signature type appropriate for the line-ending format of the original file.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object