jpen.provider

Class AbstractPenProvider.AbstractConstructor

java.lang.Object

jpen.provider.AbstractPenProvider.AbstractConstructor

All Implemented Interfaces:

PenProvider.Constructor

Direct Known Subclasses:

CocoaProvider.Constructor, SystemProvider.Constructor, WintabProvider.Constructor, XinputProvider.Constructor

Enclosing class:

AbstractPenProvider

public abstract static class AbstractPenProvider.AbstractConstructor
extends java.lang.Object
implements PenProvider.Constructor

Constructor Summary

Constructors

Constructor and Description
AbstractConstructor()

Method Summary

Modifier and Type	Method and Description
boolean	construct(PenManager penManager) This method constructs the PenProvider.
protected abstract PenProvider	constructProvider()
PenProvider	getConstructed()
PenProvider.ConstructionException	getConstructionException()
int	getExpectedNativeBuild()
int	getNativeBuild()
int	getNativeVersion()
PenManager	getPenManager()

Methods inherited from class java.lang.Object

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

Methods inherited from interface jpen.PenProvider.Constructor

constructable, getName

Constructor Detail

AbstractConstructor

public AbstractConstructor()

Method Detail

getPenManager

public PenManager getPenManager()

Specified by:

getPenManager in interface PenProvider.Constructor

Returns:

The PenManager which called the PenProvider.Constructor.construct(PenManager) method. null if the construct(PenManager) has not being called.

getConstructionException

public PenProvider.ConstructionException getConstructionException()

Specified by:

getConstructionException in interface PenProvider.Constructor

Returns:

An exception describing an unexpected condition which prevented the PenProvider from being constructed. null if the PenProvider was constructed on the PenProvider.Constructor.construct(PenManager) method call or if it has not yet being called.

getConstructed

public PenProvider getConstructed()

Specified by:

getConstructed in interface PenProvider.Constructor

Returns:

The PenProvider constructed when PenProvider.Constructor.construct(PenManager) was called. null if it couldn't be constructed or if it has not yet being called.

construct

public final boolean construct(PenManager penManager)

Description copied from interface: PenProvider.Constructor

This method constructs the PenProvider. It is called only when PenProvider.Constructor.constructable(PenManager) returns true. When this methods completes, it is expected that the PenProvider.Constructor.getConstructed() method returns the PenProvider constructed. If the PenProvider couldn't be constructed due to some condition (e.g. the required native drivers are not present) then the PenProvider.Constructor.getConstructionException() method is expected to return an exception describing the condition.

Specified by:

construct in interface PenProvider.Constructor

Returns:

true if the PenProvider was constructed. false if the PenProvider couldn't be constructed.

constructProvider

protected abstract PenProvider constructProvider()
                                          throws java.lang.Throwable

Throws:

java.lang.Throwable

getNativeVersion

public int getNativeVersion()

Specified by:

getNativeVersion in interface PenProvider.Constructor

Returns:

the native library version number. -1 if the provider does not use a native library. The version is used to construct the native library name.

getNativeBuild

public int getNativeBuild()

Specified by:

getNativeBuild in interface PenProvider.Constructor

Returns:

the loaded native library build number. -1 if the provider does not use a native library.

getExpectedNativeBuild

public int getExpectedNativeBuild()

Specified by:

getExpectedNativeBuild in interface PenProvider.Constructor

Returns:

the expected native library build number. -1 if the provider does not use a native library.