Class FileMetadata

java.lang.Object
org.c02e.jpgpj.FileMetadata

public class FileMetadata extends Object
Optional PGP message metadata.
  • Field Details

  • 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:
    • 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:
    • 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:
    • getLastModifiedDate

      public Date getLastModifiedDate()
      Returns:
      Original file modified date, or date of the epoch.
      See Also:
    • 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:
    • 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

      public FileMetadata withFile(Path file)
      See Also:
    • 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