org.apache.pdfbox.pdmodel.interactive.digitalsignature
Class PDPropBuildDataDict

java.lang.Object
  extended by org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
All Implemented Interfaces:
COSObjectable

public class PDPropBuildDataDict
extends java.lang.Object
implements COSObjectable

This represents the general property dictionaries from the build property dictionary.

Version:
$Revision: 1.1 $
Author:
Thomas Chojecki
See Also:
PDPropBuild

Constructor Summary
PDPropBuildDataDict()
          Default constructor.
PDPropBuildDataDict(COSDictionary dict)
          Constructor.
 
Method Summary
 COSBase getCOSObject()
          Convert this standard java object to a COS object.
 java.lang.String getDate()
          The build date of the software module.
 COSDictionary getDictionary()
          Convert this standard java object to a COS dictionary.
 long getMinimumRevision()
          The software module revision number, used to determinate the minimum version of software that is required in order to process this signature.
 java.lang.String getName()
          The name of the software module that was used to create the signature.
 boolean getNonEFontNoWarn()
          If there is a LegalPDF dictionary in the catalog of the PDF file and the NonEmbeddedFonts attribute in this dictionary has a non zero value, and the viewing application has a preference set to suppress the display of this warning then the value of this attribute will be set to true.
 java.lang.String getOS()
          Indicates the operation system.
 boolean getPreRelease()
          A flag that can be used by the signature handler or software module to indicate that this signature was created with unrelease software.
 long getRevision()
          The software module revision number, corresponding to the Date attribute.
 boolean getTrustedMode()
          If true, the application was in trusted mode when signing took place.
 void setDate(java.lang.String date)
          The build date of the software module.
 void setMinimumRevision(long revision)
          The software module revision number, used to determinate the minimum version of software that is required in order to process this signature.
 void setName(java.lang.String name)
          The name of the software module that was used to create the signature.
 void setOS(java.lang.String os)
          Indicates the operation system.
 void setPreRelease(boolean preRelease)
          A flag that can be used by the signature handler or software module to indicate that this signature was created with unrelease software.
 void setRevision(long revision)
          The software module revision number, corresponding to the Date attribute.
 void setTrustedMode(boolean trustedMode)
          If true, the application was in trusted mode when signing took place.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PDPropBuildDataDict

public PDPropBuildDataDict()
Default constructor.


PDPropBuildDataDict

public PDPropBuildDataDict(COSDictionary dict)
Constructor.

Parameters:
dict - The signature dictionary.
Method Detail

getCOSObject

public COSBase getCOSObject()
Convert this standard java object to a COS object.

Specified by:
getCOSObject in interface COSObjectable
Returns:
The cos object that matches this Java object.

getDictionary

public COSDictionary getDictionary()
Convert this standard java object to a COS dictionary.

Returns:
The COS dictionary that matches this Java object.

getName

public java.lang.String getName()
The name of the software module that was used to create the signature.

Returns:
the name of the software module

setName

public void setName(java.lang.String name)
The name of the software module that was used to create the signature.

Parameters:
name - is the name of the software module

getDate

public java.lang.String getDate()
The build date of the software module.

Returns:
the build date of the software module

setDate

public void setDate(java.lang.String date)
The build date of the software module. This string is normally produced by the compiler under C++.

Parameters:
date - is the build date of the software module

getRevision

public long getRevision()
The software module revision number, corresponding to the Date attribute.

Returns:
the revision of the software module

setRevision

public void setRevision(long revision)
The software module revision number, corresponding to the Date attribute.

Parameters:
revision - is the software module revision number

getMinimumRevision

public long getMinimumRevision()
The software module revision number, used to determinate the minimum version of software that is required in order to process this signature.

Returns:
the revision of the software module

setMinimumRevision

public void setMinimumRevision(long revision)
The software module revision number, used to determinate the minimum version of software that is required in order to process this signature.

Parameters:
revision - is the software module revision number

getPreRelease

public boolean getPreRelease()
A flag that can be used by the signature handler or software module to indicate that this signature was created with unrelease software.

Returns:
true if the software module or signature handler was a pre release.

setPreRelease

public void setPreRelease(boolean preRelease)
A flag that can be used by the signature handler or software module to indicate that this signature was created with unrelease software.

Parameters:
preRelease - is true if the signature was created with a unrelease software, otherwise false.

getOS

public java.lang.String getOS()
Indicates the operation system. The format isn't specified yet.

Returns:
a the operation system id or name.

setOS

public void setOS(java.lang.String os)
Indicates the operation system. The format isn't specified yet.

Parameters:
os - is a string with the system id or name.

getNonEFontNoWarn

public boolean getNonEFontNoWarn()
If there is a LegalPDF dictionary in the catalog of the PDF file and the NonEmbeddedFonts attribute in this dictionary has a non zero value, and the viewing application has a preference set to suppress the display of this warning then the value of this attribute will be set to true.

Returns:
true if NonEFontNoWarn is set to true

getTrustedMode

public boolean getTrustedMode()
If true, the application was in trusted mode when signing took place.

Returns:
true if the application was in trusted mode while signing. default: false

setTrustedMode

public void setTrustedMode(boolean trustedMode)
If true, the application was in trusted mode when signing took place.

Parameters:
trustedMode - true if the application is in trusted mode.