Gradle Build

Table of Contents

Overview

Gradle can be used to build the ICEpdf core, viewer and example projects. The project summary is as follows:


------------------------------------------------------------
Root project
------------------------------------------------------------

Root project 'icepdf-os'
+--- Project ':core'
|    \--- Project ':core:core-awt' - ICEpdf core library jar project
+--- Project ':examples'
|    +--- Project ':examples:annotation'
|    |    +--- Project ':examples:annotation:callback' - aannotation callback example
|    |    \--- Project ':examples:annotation:creation' - annotation creation example
|    +--- Project ':examples:capture'
|    |    +--- Project ':examples:capture:listener' - direcotry listener for auto image capture
|    |    +--- Project ':examples:capture:png' - pdf to png image example
|    |    +--- Project ':examples:capture:portfolio' - portfolio pdf to png image example
|    |    +--- Project ':examples:capture:svg' - pdf to svg example
|    |    +--- Project ':examples:capture:tiff' - pdf to tiff image example
|    |    \--- Project ':examples:capture:watermark' - pdf to png image with watermark example
|    +--- Project ':examples:component' - viewer component example
|    +--- Project ':examples:extraction'
|    |    +--- Project ':examples:extraction:image' - document image extraction example
|    |    +--- Project ':examples:extraction:metadata' - document metadata extraction example
|    |    \--- Project ':examples:extraction:text' - document text extraction example
|    +--- Project ':examples:javafx' - javafx SwingNode example
|    +--- Project ':examples:loadingEvents' - page loading event example
|    +--- Project ':examples:printservices' - java print services example
|    +--- Project ':examples:search'
|    |    +--- Project ':examples:search:component' - search highlight example
|    |    \--- Project ':examples:search:headless' - headless search highlight example
|    \--- Project ':examples:signatures' - signature validation example
\--- Project ':viewer'
     \--- Project ':viewer:viewer-awt' - ICEpdf viewer reference implementation project

Build the core jar using the following Gradle command

~$ gradle :core:core-awt:assemble 

Build the viewer jar using the following Gradle command

~$ gradle :viewer:viewer-awt:assemble 

Build the annotation creation example using the following Gradle command

~$  gradle :examples:annotation:creation:assemble

Build the distribution zip and tar archives

# defaultTasks allows for a call to just gradle 
~$ gradle
# or one can use the full task list 
~$ gradle projectReport, sourcesJar, genPomFileForCoreJarPub, genPomFileForViewerJarPub, osDistZip, osDistTar

Versioning

Version information is stored in the root gradle.properties file and should be updated as needed.

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

© Copyright 2017 ICEsoft Technologies Canada Corp.