Package com.luciad.lucy.addons

Class ALcyDefaultAddOn

java.lang.Object

com.luciad.lucy.addons.ALcyAddOn

com.luciad.lucy.addons.ALcyDefaultAddOn

All Implemented Interfaces:

ILcyAddOnDecoder

@Deprecated
public abstract class ALcyDefaultAddOn
extends ALcyAddOn
implements ILcyAddOnDecoder

Deprecated.

Use ALcyAddOn instead and move the logic provided by ILcyAddOnDecoder to the plugInto method

Extension of ALcyAddOn that implements some methods in a default way.

To write your own addon, you will have to override plugInto and unplugFrom without calling the super class. The plugInto method should set up the addon properly, the unplugFrom method should undo all operations performed by the plugInto method.

Note: As the ILcyAddOnDecoder interface does not add any real value, it is sufficient to extend the abstract class ALcyAddOn and implement the methods ALcyAddOn.plugInto(com.luciad.lucy.ILcyLucyEnv) and ALcyAddOn.unplugFrom(com.luciad.lucy.ILcyLucyEnv). This class is here only for backwards compatibility. If you want to write your own addon, please extend ALcyAddOn instead of this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ALcyDefaultAddOn()	Deprecated. Creates a new ALcyDefaultAddOn.

Method Summary

Modifier and Type	Method	Description
boolean	canDecodeAddOn(String aConfigSourceName)	Deprecated. Returns true if this decoder can decode the addon represented by the given string.
ALcyAddOn	decodeAddOn(String aConfigSourceName)	Deprecated. Decodes an addon given the config source name.
void	finalizeInitialization(ILcyLucyEnv aLucyEnv)	Deprecated. initialize and finalizeInitialization are both replaced by one method: plugInto
void	initialize(ILcyLucyEnv aLucyEnv, String aConfigSourceName)	Deprecated. initialize and finalizeInitialization are both replaced by one method: plugInto
void	plugInto(ILcyLucyEnv aLucyEnv)	Deprecated. Override this method and don't call super to init your addon.
void	terminate(ILcyLucyEnv aLucyEnv)	Deprecated. Has been replaced by unplugFrom
void	unplugFrom(ILcyLucyEnv aLucyEnv)	Deprecated. Override this method and don't call super to tear down your addon.

Methods inherited from class com.luciad.lucy.addons.ALcyAddOn

getConfigSourceName, getDisplayName, setConfigSourceName, setDisplayName

Methods inherited from class java.lang.Object

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

Constructor Details

ALcyDefaultAddOn

protected ALcyDefaultAddOn()

Deprecated.

Creates a new ALcyDefaultAddOn.

Method Details

terminate

@Deprecated
public void terminate(ILcyLucyEnv aLucyEnv)

Deprecated.

Has been replaced by unplugFrom

Terminates this add-on.

Parameters:

aLucyEnv - The Lucy environment.

See Also:

• unplugFrom(com.luciad.lucy.ILcyLucyEnv)

initialize

@Deprecated
public void initialize(ILcyLucyEnv aLucyEnv,
 String aConfigSourceName)

Deprecated.

initialize and finalizeInitialization are both replaced by one method: plugInto

Initializes this add-on.

Parameters:

aLucyEnv - The Lucy environment.

aConfigSourceName - The source name of the configuration.

See Also:

• plugInto(com.luciad.lucy.ILcyLucyEnv)

finalizeInitialization

@Deprecated
public void finalizeInitialization(ILcyLucyEnv aLucyEnv)

Deprecated.

initialize and finalizeInitialization are both replaced by one method: plugInto

Performs the second-pass initialization of this add-on.

Parameters:

aLucyEnv - The Lucy environment.

See Also:

• plugInto(com.luciad.lucy.ILcyLucyEnv)

plugInto

public void plugInto(ILcyLucyEnv aLucyEnv)

Deprecated.

Override this method and don't call super to init your addon.

Specified by:

plugInto in class ALcyAddOn

Parameters:

aLucyEnv - The Lucy environment to plug into.

See Also:

• ALcyAddOn.unplugFrom(com.luciad.lucy.ILcyLucyEnv)

unplugFrom

public void unplugFrom(ILcyLucyEnv aLucyEnv)

Deprecated.

Override this method and don't call super to tear down your addon.

Specified by:

unplugFrom in class ALcyAddOn

Parameters:

aLucyEnv - The Lucy environment to unplug from.

See Also:

• ALcyAddOn.plugInto(com.luciad.lucy.ILcyLucyEnv)

canDecodeAddOn

public boolean canDecodeAddOn(String aConfigSourceName)

Deprecated.

Description copied from interface: ILcyAddOnDecoder

Returns true if this decoder can decode the addon represented by the given string.

Specified by:

canDecodeAddOn in interface ILcyAddOnDecoder

Parameters:

aConfigSourceName - The string that represents the addon.

Returns:

True if an addon can be decoded for the given config source name, false otherwise.

See Also:

• ILcyAddOnDecoder.decodeAddOn(java.lang.String)

decodeAddOn

public ALcyAddOn decodeAddOn(String aConfigSourceName)
                      throws IOException

Deprecated.

Description copied from interface: ILcyAddOnDecoder

Decodes an addon given the config source name. The config source name can be anything: a file name, an url, a database access descriptor. However implementations might choose to only support a certain type

Specified by:

decodeAddOn in interface ILcyAddOnDecoder

Parameters:

aConfigSourceName - The string that represents the addon.

Returns:

The decoded addon.

Throws:

IOException - In case any io exceptions occur during the decoding.

See Also:

• ILcyAddOnDecoder.canDecodeAddOn(java.lang.String)