com.ironsoftware.ironpdf

Class Settings

java.lang.Object

com.ironsoftware.ironpdf.Settings

public final class Settings
extends Object

Important global settings for configuration of IronPDF for Java

Constructor Summary

Constructors

Constructor and Description
Settings()

Method Summary

Modifier and Type	Method and Description
static Path	getIronPdfEngineFolder() We will look for IronPdfEngine (binaries) in this folder first.
static String	getIronPdfEngineHost() Get IronPdfEngine host string.
static int	getIronPdfEnginePort() Get IronPdfEngine port int.
static String	getIronPdfEngineVersion() Gets iron pdf engine version.
static Path	getLogPath() Gets IronPdfEngine log file path.
static boolean	isDebug() Is debug boolean.
static void	setDebug(boolean isDebug) Enable or disable debug mode.
static void	setIronPdfEngineFolder(Path path) Sets a custom IronPdfEngine folder path.
static void	setIronPdfEngineHost(String host) Set iron pdf engine host.
static void	setIronPdfEnginePort(int port) Set IronPdfEngine port.
static void	setLogPath(Path path) Sets IronPdfEngine log file path.

Methods inherited from class java.lang.Object

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

Constructor Detail

Settings

public Settings()

Method Detail

getIronPdfEngineVersion

public static String getIronPdfEngineVersion()

Gets iron pdf engine version.

Returns:

The current IronPdfEngine version

isDebug

public static boolean isDebug()

Is debug boolean.

Returns:

true if debug mode is enabled.

setDebug

public static void setDebug(boolean isDebug)

Enable or disable debug mode.

***Please set before calling any IronPdf function.***

Parameters:

isDebug - the is debug enabled

getIronPdfEngineFolder

public static Path getIronPdfEngineFolder()

We will look for IronPdfEngine (binaries) in this folder first. If binaries are not present or are of an older version, the software will automatically try to download all the latest required binaries into this folder.

Returns:

custom IronPdfEngine folder.

setIronPdfEngineFolder

public static void setIronPdfEngineFolder(Path path)

Sets a custom IronPdfEngine folder path. We will look for IronPdfEngine (binaries) in this folder first.

***Please set before calling any IronPdf function.*** If binaries are not present or are of an older version, the software will automatically try to download all the latest required binaries into this folder.

Parameters:

path - the path

getLogPath

public static Path getLogPath()

Gets IronPdfEngine log file path.

Returns:

the log file path

setLogPath

public static void setLogPath(Path path)

Sets IronPdfEngine log file path.

***Please set before calling any IronPdf function.***

Parameters:

path - the log file path

setIronPdfEngineHost

public static void setIronPdfEngineHost(String host)

Set iron pdf engine host.

Parameters:

host - the host

getIronPdfEngineHost

public static String getIronPdfEngineHost()

Get IronPdfEngine host string.

Returns:

the host string

setIronPdfEnginePort

public static void setIronPdfEnginePort(int port)

Set IronPdfEngine port. Default port will pick automatically.

Parameters:

port - the port

getIronPdfEnginePort

public static int getIronPdfEnginePort()

Get IronPdfEngine port int. Default port will pick automatically.

Returns:

the port int