Package org.c02e.jpgpj
Class FileMetadata
- java.lang.Object
-
- org.c02e.jpgpj.FileMetadata
-
public class FileMetadata extends java.lang.Object
Optional PGP message metadata.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FileMetadata.Format
Format for line-ending normalization.static class
FileMetadata.Signature
Signature found by decryptor.
-
Field Summary
Fields Modifier and Type Field Description static FileMetadata.Format
DEFAULT_FORMAT
static java.lang.String
DEFAULT_NAME
private FileMetadata.Format
format
private long
lastModified
private long
length
private java.lang.String
name
private java.util.List<FileMetadata.Signature>
signatures
private Ring
verified
-
Constructor Summary
Constructors Constructor Description FileMetadata()
Constructs a metadata object with default values.FileMetadata(java.io.File file)
Constructs a metadata object from a file.FileMetadata(java.lang.String name)
Constructs a metadata object with the specified file name .FileMetadata(java.lang.String name, FileMetadata.Format format)
Constructs a metadata object with the specified file name and line-ending format.FileMetadata(java.lang.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(java.nio.file.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
FileMetadata.Format
getFormat()
long
getLastModified()
java.util.Date
getLastModifiedDate()
long
getLength()
java.lang.String
getName()
java.util.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(java.io.File file)
void
setFile(java.nio.file.Path file)
void
setFormat(FileMetadata.Format x)
void
setLastModified(long x)
void
setLength(long x)
void
setName(java.lang.String x)
java.lang.String
toString()
FileMetadata
withFile(java.io.File file)
FileMetadata
withFile(java.nio.file.Path file)
FileMetadata
withFormat(FileMetadata.Format x)
FileMetadata
withLastModified(long x)
FileMetadata
withLength(long x)
FileMetadata
withName(java.lang.String x)
-
-
-
Field Detail
-
DEFAULT_NAME
public static final java.lang.String DEFAULT_NAME
- See Also:
- Constant Field Values
-
DEFAULT_FORMAT
public static final FileMetadata.Format DEFAULT_FORMAT
-
name
private java.lang.String name
-
format
private FileMetadata.Format format
-
length
private long length
-
lastModified
private long lastModified
-
signatures
private final java.util.List<FileMetadata.Signature> signatures
-
verified
private final Ring verified
-
-
Constructor Detail
-
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(java.io.File file)
Constructs a metadata object from a file.
-
FileMetadata
public FileMetadata(java.nio.file.Path file)
Constructs a metadata object from a file.
-
FileMetadata
public FileMetadata(java.lang.String name)
Constructs a metadata object with the specified file name .
-
FileMetadata
public FileMetadata(java.lang.String name, FileMetadata.Format format)
Constructs a metadata object with the specified file name and line-ending format.
-
FileMetadata
public FileMetadata(java.lang.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 Detail
-
getName
public java.lang.String getName()
- Returns:
- Original file name ("foo.txt"), or "".
-
setName
public void setName(java.lang.String x)
- Parameters:
x
- Original file name ("foo.txt") - set to "" ifnull
-
withName
public FileMetadata withName(java.lang.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 java.util.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, orDEFAULT_FORMAT
ifnull
.
-
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'sKey.getSigningUid()
method.
-
getSignatures
public java.util.List<FileMetadata.Signature> getSignatures()
Signatures found on the file, including unverified signatures.
-
setFile
public void setFile(java.io.File file)
- Parameters:
file
- OriginalFile
from which to extract the metadata - ignored ifnull
Does not extractFileMetadata.Format
metadata.
-
setFile
public void setFile(java.nio.file.Path file)
- Parameters:
file
- OriginalPath
from which to extract the metadata - ignored ifnull
Does not extractFileMetadata.Format
metadata.
-
withFile
public FileMetadata withFile(java.io.File file)
- See Also:
withFile(Path)
-
withFile
public FileMetadata withFile(java.nio.file.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 classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-