pdfOptimizer 3.0.1 API
iText.Pdfoptimizer.OptimizationSession Class Reference

Class is used to handle auxiliary activities during the optimization processing (i. e. generating optimization report). More...

Public Member Functions

  OptimizationSession (DefaultReportBuilder reportBuilder)
  Creates an instance of OptimizationSession with provided iText.Pdfoptimizer.Report.Builder.DefaultReportBuilder. More...
 
virtual void  RegisterEvent (SeverityLevel level, String message, params Object[] args)
  Registers an event of optimization process. More...
 
virtual Object  GetStoredValue (String key)
  Retrieves stored value associated with the provided key. More...
 
virtual void  StoreValue (String key, Object value)
  Puts a value and a key associated with it into internal storage. More...
 

Static Public Attributes

const String  WRITER_PROPERTIES_KEY = "writer-properties-key"
 
const String  RESOURCES_FOR_CONVERSION_KEY = "resources-for-conversion-key"
 
const String  CONVERTED_CONTENT_STREAMS_KEY = "converted-content-streams-key"
 
const String  RESOURCES_FOR_STREAM_PROCESSING_KEY = "resources-for-stream-processing-key"
 
const String  PROCESSED_CONTENT_STREAMS_KEY = "processed-content-streams-key"
 
const String  ANY_ERRORS_OCCURRED_KEY = "any-errors-occurred-key"
 
const String  CURRENT_RESOURCES_KEY = "current-resources-key"
 
const String  IS_PDF_A_DOCUMENT_KEY = "is-pdf-a-document-key"
 
const String  CANVAS_PROCESSOR_KEY = "canvas-processor-key"
 
const String  EVENT_LISTENER_KEY = "event-listener-key"
 

Detailed Description

Class is used to handle auxiliary activities during the optimization processing (i. e. generating optimization report).

Constructor & Destructor Documentation

◆ OptimizationSession()

iText.Pdfoptimizer.OptimizationSession.OptimizationSession ( DefaultReportBuilder  reportBuilder )
inline

Creates an instance of OptimizationSession with provided iText.Pdfoptimizer.Report.Builder.DefaultReportBuilder.

Parameters
reportBuilder is a report builder

Member Function Documentation

◆ GetStoredValue()

virtual Object iText.Pdfoptimizer.OptimizationSession.GetStoredValue ( String  key )
inlinevirtual

Retrieves stored value associated with the provided key.

Parameters
key is a key to access the value
Returns
the value associated with the key

◆ RegisterEvent()

virtual void iText.Pdfoptimizer.OptimizationSession.RegisterEvent ( SeverityLevel  level,
String  message,
params Object[]  args 
)
inlinevirtual

Registers an event of optimization process.

Parameters
level is a severity level of the event
message is a text message of the event
args are arguments of the message if it is parametrized

◆ StoreValue()

virtual void iText.Pdfoptimizer.OptimizationSession.StoreValue ( String  key,
Object  value 
)
inlinevirtual

Puts a value and a key associated with it into internal storage.

Parameters
key is a key to access the value
value is a value associated with the key