Package com.itextpdf.pdfoptimizer.report.builder

Class DefaultReportBuilder

java.lang.Object

com.itextpdf.pdfoptimizer.report.builder.DefaultReportBuilder

Direct Known Subclasses:

FileReportBuilder, LogReportBuilder

 public class DefaultReportBuilder extends Object 
      

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

Constructor Summary

Constructors

Constructor	Description
DefaultReportBuilder(SeverityLevel minimalLevel)	Creates an instance of default ReportBuilder with provided minimal severity level.

Method Summary

Modifier and Type	Method	Description
OptimizationResult	build()	Builds a report based on messages logged with log(SeverityLevel, Date, LocationStack, String, Object...).
protected ArrayList<ReportMessage>	getMessages()	Returns list of logged messages.
final ReportMessage	log(SeverityLevel level, Date time, LocationStack location, String message, Object... params)	Creates a message during PDF optimization process with provided severity level and message.
protected void	processMessage(ReportMessage message)	Allows to provide additional logic of message processing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultReportBuilder

 public DefaultReportBuilder 
             (SeverityLevel minimalLevel) 
            

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

Parameters:

minimalLevel - is a minimal SeverityLevel

Method Details

log

 public final ReportMessage log 
             (SeverityLevel level, Date time, LocationStack location, String message, Object... params) 
            

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

Parameters:

level - is a 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

build

 public OptimizationResult build() 
            

Builds a report based on messages logged with log(SeverityLevel, Date, LocationStack, String, Object...).

Returns:

an optimization result object

getMessages

 protected ArrayList<ReportMessage> getMessages() 
            

Returns list of logged messages.

Returns:

the list of messages

processMessage

 protected void processMessage 
             (ReportMessage message) 
            

Allows to provide additional logic of message processing. The method is called inside log(SeverityLevel, Date, LocationStack, String, Object...) method.

Parameters:

message - is a message to process