Class FileMetadata


  • public class FileMetadata
    extends java.lang.Object
    Optional PGP message metadata.
    • 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 "" if null
      • 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.
      • 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.
      • 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 java.util.List<FileMetadata.Signature> getSignatures()
        Signatures found on the file, including unverified signatures.
      • setFile

        public void setFile​(java.io.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​(java.nio.file.Path file)
        Parameters:
        file - Original Path from which to extract the metadata - ignored if null Does not extract FileMetadata.Format metadata.
      • 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 java.lang.Object
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object