Package com.realobjects.pdfreactor.useragent

Class UserAgent

java.lang.Object

com.realobjects.pdfreactor.useragent.UserAgent

All Implemented Interfaces:

Closeable, AutoCloseable

public class UserAgent
extends Object
implements Closeable

A UserAgent can be passed to a PDFreactor conversion via the Configuration object.

The lifecycle of user agents doesn't end with the conversion and instances are intended to be re-used for multiple conversions.

Settings that are specified in the UserAgentConfiguration always take precedence over those specified in the Configuration, even if the are null.

User agent instances should be closed after they are no longer needed.

Constructor Summary

Constructors

Constructor	Description
UserAgent(UserAgentConfiguration config)	Construct a new UserAgent.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the UserAgent, freeing all of its resources.

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserAgent

public UserAgent(UserAgentConfiguration config)
          throws UserAgentException

Construct a new UserAgent.

Parameters:

config - The configuration.

Throws:

UserAgentException - An exception when the UserAgent could not be created, possibly due to misconfiguration.

Method Details

close

public void close()
           throws IOException

Closes the UserAgent, freeing all of its resources. It is best practice to close the instance if it is no longer needed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException