pdfOptimizer 3.0.1 API
iText.Pdfoptimizer.Report.Builder.DefaultReportBuilder Class Reference

The goal of the class is to generate an optimization report. More...

Inheritance diagram for iText.Pdfoptimizer.Report.Builder.DefaultReportBuilder:
iText.Pdfoptimizer.Report.Builder.FileReportBuilder iText.Pdfoptimizer.Report.Builder.LogReportBuilder

Public Member Functions

  DefaultReportBuilder (SeverityLevel minimalLevel)
  Creates an instance of default ReportBuilder with provided minimal severity level. More...
 
ReportMessage  Log (SeverityLevel level, DateTime time, LocationStack location, String message, params Object[] @params)
  Creates a message during PDF optimization process with provided severity level and message. More...
 
virtual OptimizationResult  Build ()
  Builds a report based on messages logged with Log(iText.Pdfoptimizer.Report.Message.SeverityLevel, System.DateTime, iText.Pdfoptimizer.Report.Location.LocationStack, System.String, System.Object[]) . More...
 

Detailed Description

The goal of the class is to generate an optimization report.

Constructor & Destructor Documentation

◆ DefaultReportBuilder()

iText.Pdfoptimizer.Report.Builder.DefaultReportBuilder.DefaultReportBuilder ( SeverityLevel  minimalLevel )
inline

Creates an instance of default ReportBuilder with provided minimal severity level.

Parameters
minimalLevel is a minimal iText.Pdfoptimizer.Report.Message.SeverityLevel

Member Function Documentation

◆ Build()

virtual OptimizationResult iText.Pdfoptimizer.Report.Builder.DefaultReportBuilder.Build ( )
inlinevirtual

Builds a report based on messages logged with Log(iText.Pdfoptimizer.Report.Message.SeverityLevel, System.DateTime, iText.Pdfoptimizer.Report.Location.LocationStack, System.String, System.Object[]) .

Returns
an optimization result object

Reimplemented in iText.Pdfoptimizer.Report.Builder.FileReportBuilder.

◆ Log()

ReportMessage iText.Pdfoptimizer.Report.Builder.DefaultReportBuilder.Log ( SeverityLevel  level,
DateTime  time,
LocationStack  location,
String  message,
params Object @[]  params 
)
inline

Creates a message during PDF optimization process with provided severity level and message.

Creates a message during PDF optimization process with provided severity level and message. Parametrized messages are also supported.

Parameters
level is a iText.Pdfoptimizer.Report.Message.SeverityLevel of the message
time is a time when the message was generated
location is a string representation of the origin of the message
message is a text of the message
params is an array of parameters of the message
Returns
generated message if it was logged and null otherwise