org.fax4j.spi.comm

Class AbstractFaxModemAdapter

java.lang.Object

org.fax4j.spi.comm.AbstractFaxModemAdapter

All Implemented Interfaces:

ProviderImplementation, FaxModemAdapter

Direct Known Subclasses:

AbstractFax4JFaxModemAdapter

public abstract class AbstractFaxModemAdapter
extends Object
implements FaxModemAdapter

This class provides partial/common functionlity of the fax modem adapter interface.

Since:

0.38

Version:

1.03

Author:

Sagie Gur-Ari

Constructor Summary

Constructors

Constructor and Description
AbstractFaxModemAdapter() This is the class constructor.

Method Summary

Modifier and Type	Method and Description
void	initialize(FaxClientSpi faxClientSpi) This function initializes the fax modem adapter.
protected abstract void	initializeImpl(FaxClientSpi faxClientSpi) This function initializes the fax modem adapter.
void	submitFaxJob(FaxJob faxJob, CommPortAdapter adapter) This function will submit a new fax job. The fax job ID may be populated by this method in the provided fax job object.
protected abstract void	submitFaxJobImpl(FaxJob faxJob, CommPortAdapter adapter) This function will submit a new fax job. The fax job ID may be populated by this method in the provided fax job object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fax4j.common.ProviderImplementation

getProvider

Constructor Detail

AbstractFaxModemAdapter

public AbstractFaxModemAdapter()

This is the class constructor.

Method Detail

initialize

public void initialize(FaxClientSpi faxClientSpi)

This function initializes the fax modem adapter.

Specified by:

initialize in interface FaxModemAdapter

Parameters:

faxClientSpi - The fax client SPI

submitFaxJob

public void submitFaxJob(FaxJob faxJob,
                         CommPortAdapter adapter)

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

Specified by:

submitFaxJob in interface FaxModemAdapter

Parameters:

faxJob - The fax job object containing the needed information

adapter - The COMM port adapter

initializeImpl

protected abstract void initializeImpl(FaxClientSpi faxClientSpi)

This function initializes the fax modem adapter.

Parameters:

faxClientSpi - The fax client SPI

submitFaxJobImpl

protected abstract void submitFaxJobImpl(FaxJob faxJob,
                                         CommPortAdapter adapter)

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

Parameters:

faxJob - The fax job object containing the needed information

adapter - The COMM port adapter