tom.platform
Interface OptionOwner

All Known Subinterfaces:

Plugin

public interface OptionOwner

This interface contains the option-related methods of Plugin.

Author:

Grégory ANDRIEN

Method Summary

tom.platform.adt.platformoption.types.PlatformOptionList	getDeclaredOptionList() Returns a list containing the options the plugin declares.
tom.platform.adt.platformoption.types.PlatformOptionList	getRequiredOptionList() Returns a list containing the options the plugin requires in order to do what is expected of it.
void	optionChanged(String name, Object value) Method triggered each time an option own is changed: The Option owner can react to that change
void	setOptionManager(OptionManager om) Sets the associated OptionManager

Method Detail

getDeclaredOptionList

tom.platform.adt.platformoption.types.PlatformOptionList getDeclaredOptionList()

Returns a list containing the options the plugin declares.

Returns:

the options declared by the plugin

getRequiredOptionList

tom.platform.adt.platformoption.types.PlatformOptionList getRequiredOptionList()

Returns a list containing the options the plugin requires in order to do what is expected of it. A plugin may indeed require that some options are set to specific values depending on which tasks it is told to accomplish.

Returns:

the plugin's prerequisites

optionChanged

void optionChanged(String name,
                   Object value)

Method triggered each time an option own is changed: The Option owner can react to that change

Parameters:

name - the option's name

value - the option's value

setOptionManager

void setOptionManager(OptionManager om)

Sets the associated OptionManager

Parameters:

om - the option manager