All Packages Class Hierarchy This Package Previous Next Index
Interface com.ibm.beans.tools.dip.MorphView
- public interface interface MorphView
The MorphView interface defines those methods used by the MorphController
class to interface with the view given to the user.
- See Also:
- MorphController
-
BLANK
- Constant to indicate a blank space on a View.
-
SAVE_TO_JAR
- Location constant that indicates the view has requested that the new
dippable class be saved to a jar.
-
SAVE_TO_ORIG
- Location constant that indicates the view has requested that the new
dippable class be saved to the original location.
-
SAVE_TO_REPOS
- Location constant that indicates the view has requested that the new
dippable class be saved to a repository directory.
-
addMorphViewListener(MorphViewListener)
- Adds a MorphViewListener to the listener list.
-
addToListOfAdditionalInterfaces(String)
- Adds an interface name to the list of interfaces to be considered
as part of an additional API.
-
addToListOfClasses(String)
- Adds a class name to the list of classes to be considered for
morphing.
-
addToListOfDips(String)
- Adds the class name of a dip to the list of dips to be considered for
morphing.
-
addToListOfFinalMethodNames(String)
- Adds a method name to the list of methods to be considered as
final methods.
-
addToListOfInterfaces(String)
- Adds an interface name to the list of interfaces to be considered for
morphing.
-
cleanup()
- Performs any cleanup needed so the
MorphView implementation can terminate.
-
displayDipCustomizer(Customizer)
- Displays a dip customizer so that any customization needed by a pre-dip
is included in the new dippable bean.
-
fireMorphView(int, String, String[], int)
- Reports a morph view change to the registered listeners.
-
getAdditionalClasses()
- Gets the array of additional API class names to be added to the
dippable class.
-
getAdditionalInterfaces()
- Gets the array of additional API interface names to be added to the
dippable class.
-
getClassName()
- Gets the name of the class to be used in the morphing process.
-
getDips()
- Gets the list of dips to be applied to the dippable class.
-
getDoBeanInfo()
- Determines whether the new dippable class should have a corresponding
BeanInfo.
-
getDoDipsSpecifyOverrides()
- Determines whether the pre-dips
specify which methods the dippable bean should
override.
-
getDoDisplay()
- Determines whether the MorphView implementation is visible.
-
getDoExtended()
- Determines whether the new dippable class should implement
com.ibm.beans.dip.DippableExtended.
-
getDoFinal()
- Determines whether the new dippable class will be a final class.
-
getDoHideOriginal()
- Determines whether the original bean should be marked as a "Java-Bean"
in the manifest of the repository that contains the new dippable class.
-
getDoInheritance()
- Determines whether the new dippable class should be created using
inheritance or aggregation.
-
getDoOverrideParentMethods()
- Determines which methods the dippable bean should override.
-
getFinalMethodNames()
- Gets the list of method names in the new dippable class that should
be final methods.
-
getInterfaceName()
- Gets the name of the interface to be used in the morphing process.
-
getNewClassName()
- Determines the new name of the dippable bean.
-
getSaveToLocation()
- Determines the location where the new dippable class will be saved.
-
getSaveToState()
- Determines the location state indicating where the new dippable class
will be saved.
-
removeAllElementsFromListOfAdditionalInterfaces()
- Removes all the interface name(s) from the list of additional
interfaces.
-
removeAllElementsFromListOfFinalMethodNames()
- Removes all the method name(s) from the list of method names
to be considered as final methods.
-
removeAllElementsFromListOfInterfaces()
- Removes all the interface name(s) from the list of interfaces
to be considered for morphing.
-
removeFromListOfClasses(String)
- Removes a class name from the list of classes to be considered for
morphing.
-
removeFromListOfDips(String)
- Removes a class name from the list of dips to be considered for
morphing.
-
removeMorphViewListener(MorphViewListener)
- Removes a MorphViewListener from the listener list.
-
selectClass(String)
- Select a class name from the list of classes to be considered for
morphing.
-
selectDip(String)
- Selects a class name from the list of dips to be considered for
morphing.
-
selectFinalMethodName(String)
- Select a method name from the list of method names to be considered as
final methods.
-
setDoBeanInfo(boolean)
- Specifies whether a BeanInfo should be generated.
-
setDoDipsSpecifyOverrides(boolean)
- Specifies whether the pre-dips determine
which methods the dippable bean should
override.
-
setDoDisplay(boolean)
- Shows or hides the MorphView implementation.
-
setDoExtended(boolean)
- Specifies the implementation interface for the new dippable class.
-
setDoFinal(boolean)
- Specifies whether the new dippable class will be a final class.
-
setDoHideOriginal(boolean)
- Specifies whether the original bean should be marked as a "Java-Bean"
in the manifest of the repository that contains the new dippable class.
-
setDoInheritance(boolean)
- Specifies the implementation approach to the new dippable class.
-
setDoOverrideParentMethods(boolean)
- Specifies which methods the dippable bean should override.
-
setErrorMessage(String)
- Reports an error message to the MorphView instance.
-
setNewClassName(String)
- Sets the new name of the dippable bean.
-
setSaveToLocation(int, String)
- Specifies where the dippable class will be saved.
-
setStatusMessage(String)
- Reports a status, or informational, message to the MorphView instance.
SAVE_TO_JAR
public static final int SAVE_TO_JAR
- Location constant that indicates the view has requested that the new
dippable class be saved to a jar.
SAVE_TO_REPOS
public static final int SAVE_TO_REPOS
- Location constant that indicates the view has requested that the new
dippable class be saved to a repository directory.
SAVE_TO_ORIG
public static final int SAVE_TO_ORIG
- Location constant that indicates the view has requested that the new
dippable class be saved to the original location.
BLANK
public static final String BLANK
- Constant to indicate a blank space on a View.
getDoDisplay
public abstract boolean getDoDisplay()
- Determines whether the MorphView implementation is visible.
- Returns:
-
true
if the MorphView implementation is displayed
to the user; false
otherwise.
setDoDisplay
public abstract void setDoDisplay(boolean flag)
- Shows or hides the MorphView implementation.
- Parameters:
- flag -
true
if the MorphView implementation is
displayed to the user; false
otherwise.
cleanup
public abstract void cleanup()
- Performs any cleanup needed so the
MorphView implementation can terminate.
addMorphViewListener
public abstract void addMorphViewListener(MorphViewListener listener)
- Adds a MorphViewListener to the listener list.
The MorphController will add a listener to the MorphView implementation.
- Parameters:
- listener - The MorphViewListener to be added.
removeMorphViewListener
public abstract void removeMorphViewListener(MorphViewListener listener)
- Removes a MorphViewListener from the listener list.
- Parameters:
- listener - The MorphViewListener to be removed
fireMorphView
public abstract void fireMorphView(int actionID,
String directoryName,
String className[],
int index)
- Reports a morph view change to the registered listeners.
When something happens on the view to the user, and the
corresponding MorphController instance needs to do something
about it, this method is used to send an event to the MorphController
instance.
- Parameters:
- actionID
-
-
One of the MorphViewEvent action constants indicating
what action needs to be taken.
- directoryName
-
-
The name of the directory associated with the
event. This parameter is used when the actionID is one
of the following:
- MorphViewEvent.LOAD_CLASSES_MODEL
- MorphViewEvent.LOAD_DIPS_MODEL
- className
-
-
The array of class names associated with the
event. This parameter is used when the actionID is one
of the following:
- MorphViewEvent.CLASS_SELECTED
- MorphViewEvent.ADDITIONAL_CLASS_SELECTED
- MorphViewEvent.DIP_SELECTED
- MorphViewEvent.DIP_DESELECTED
- index
-
-
The optional index associated with className.
setErrorMessage
public abstract void setErrorMessage(String msg)
- Reports an error message to the MorphView instance.
- Parameters:
- msg - The error message to be displayed to the user.
setStatusMessage
public abstract void setStatusMessage(String msg)
- Reports a status, or informational, message to the MorphView instance.
- Parameters:
- msg - The status message to be displayed to the user.
getClassName
public abstract String getClassName()
- Gets the name of the class to be used in the morphing process.
If inheritance was chosen, this class will be the parent of the new
dippable class. If aggregation was chosen, this class will
provide the implementation for the new dippable class.
- Returns:
- The package qualified class name to be used in the morphing
process.
addToListOfClasses
public abstract void addToListOfClasses(String className)
- Adds a class name to the list of classes to be considered for
morphing. The user selects a class name from this list.
- Parameters:
- className - A package qualified class name that is a candidate
for morphing.
removeFromListOfClasses
public abstract void removeFromListOfClasses(String className)
- Removes a class name from the list of classes to be considered for
morphing. The user selects a class name from this list.
- Parameters:
- className - A package qualified class name to be removed as
a candidate for morphing.
selectClass
public abstract void selectClass(String className)
- Select a class name from the list of classes to be considered for
morphing. This method pre-selects a class name for the user.
The user has the option of changing this selection before initiating
morphing.
- Parameters:
- className - A package qualified class name.
getInterfaceName
public abstract String getInterfaceName()
- Gets the name of the interface to be used in the morphing process.
If inheritance was chosen, this interface will not be used.
If aggregation was chosen, this interface will be implemented by
the new dippable class.
- Returns:
- The package qualified interface name to be used in the morphing
process.
addToListOfInterfaces
public abstract void addToListOfInterfaces(String interfaceName)
- Adds an interface name to the list of interfaces to be considered for
morphing. The user selects an interface name from this list.
- Parameters:
- interfaceName - A package qualified interface name.
removeAllElementsFromListOfInterfaces
public abstract void removeAllElementsFromListOfInterfaces()
- Removes all the interface name(s) from the list of interfaces
to be considered for morphing. After this method is called the
list of interface names is empty.
getDoInheritance
public abstract boolean getDoInheritance()
- Determines whether the new dippable class should be created using
inheritance or aggregation.
- Returns:
-
true
if the dippable class should use inheritance;
false
if the dippable class should use aggregation.
setDoInheritance
public abstract void setDoInheritance(boolean flag)
- Specifies the implementation approach to the new dippable class.
- Parameters:
- flag
-
-
true
if the dippable class should use
inheritance;
false
if the dippable class
should use aggregation.
getDoExtended
public abstract boolean getDoExtended()
- Determines whether the new dippable class should implement
com.ibm.beans.dip.DippableExtended.
- Returns:
-
true
if the dippable class should implement
com.ibm.beans.dip.DippableExtended;
false
if the dippable class should just implement
com.ibm.beans.dip.Dippable.
setDoExtended
public abstract void setDoExtended(boolean flag)
- Specifies the implementation interface for the new dippable class.
- Parameters:
- flag
-
-
true
if the dippable class should implement
com.ibm.beans.dip.DippableExtended;
false
if the dippable class should just implement
com.ibm.beans.dip.Dippable.
getDoBeanInfo
public abstract boolean getDoBeanInfo()
- Determines whether the new dippable class should have a corresponding
BeanInfo.
- Returns:
-
true
if the dippable class should have a
corresponding BeanInfo; false
otherwise.
setDoBeanInfo
public abstract void setDoBeanInfo(boolean flag)
- Specifies whether a BeanInfo should be generated.
- Parameters:
- flag -
true
if the dippable class should have a
corresponding BeanInfo; false
otherwise.
getNewClassName
public abstract String getNewClassName()
- Determines the new name of the dippable bean.
- Returns:
-
null
if no unique class name was provided
by the user and the default name should be used;
otherwise this method returns the new package qualified
class name
of the dippable class to be created.
setNewClassName
public abstract void setNewClassName(String name)
- Sets the new name of the dippable bean.
- Parameters:
- name - The new package qualified class name of the dippable
class to be created.
getDips
public abstract String[] getDips()
- Gets the list of dips to be applied to the dippable class.
These dips will be appled to the dippable class in it's constructor.
These dips are sometimes referred to as pre-dips.
- Returns:
-
null
if no dips are to be applied to the new
dippable class; otherwise an array of dip names.
addToListOfDips
public abstract void addToListOfDips(String dipName)
- Adds the class name of a dip to the list of dips to be considered for
morphing. The user selects one or more dip names from this list to
be pre-dips.
- Parameters:
- dipName - A package qualified class name of a dip.
removeFromListOfDips
public abstract void removeFromListOfDips(String dipName)
- Removes a class name from the list of dips to be considered for
morphing. The user selects one or more dip names from this list to
be pre-dips.
- Parameters:
- dipName - A package qualified class name of a dip.
selectDip
public abstract void selectDip(String dipName)
- Selects a class name from the list of dips to be considered for
morphing. This method pre-selects a dip name for the user.
The user has the option of changing this selection before initiating
morphing.
- Parameters:
- dipName - A package qualified class name of a dip.
displayDipCustomizer
public abstract void displayDipCustomizer(Customizer dipCustomizer)
- Displays a dip customizer so that any customization needed by a pre-dip
is included in the new dippable bean.
- Parameters:
- dipCustomizer - The customizer for a dip
getDoOverrideParentMethods
public abstract boolean getDoOverrideParentMethods()
- Determines which methods the dippable bean should override.
- Returns:
-
true
means override all general methods from
all parent classes;
false
means override only the general methods
in the original bean.
setDoOverrideParentMethods
public abstract void setDoOverrideParentMethods(boolean flag)
- Specifies which methods the dippable bean should override.
- Parameters:
- flag
-
-
true
means override all general methods from
all parent classes;
false
means override only the general methods
in the original bean.
getDoDipsSpecifyOverrides
public abstract boolean getDoDipsSpecifyOverrides()
- Determines whether the pre-dips
specify which methods the dippable bean should
override. The pre-dips are the dips applied in the dippable class's
constructor(s).
- Returns:
-
true
if the predips specify what methods will
be overridden in the dippable bean;
false
otherwise.
setDoDipsSpecifyOverrides
public abstract void setDoDipsSpecifyOverrides(boolean flag)
- Specifies whether the pre-dips determine
which methods the dippable bean should
override. The pre-dips are the dips applied in the dippable class's
constructor(s).
- Parameters:
- flag -
true
if the predips specify which methods will
be overridden in the dippable bean;
false
otherwise.
getDoFinal
public abstract boolean getDoFinal()
- Determines whether the new dippable class will be a final class.
- Returns:
-
true
if the new dippable class will be a final
class; false
otherwise.
setDoFinal
public abstract void setDoFinal(boolean flag)
- Specifies whether the new dippable class will be a final class.
- Parameters:
- flag -
true
if the new dippable class will be a final
class; false
otherwise.
getFinalMethodNames
public abstract String[] getFinalMethodNames()
- Gets the list of method names in the new dippable class that should
be final methods.
- Returns:
-
null
if no methods are to be final methods;
otherwise an array of method names.
addToListOfFinalMethodNames
public abstract void addToListOfFinalMethodNames(String methodName)
- Adds a method name to the list of methods to be considered as
final methods. The user selects a class name from this list.
- Parameters:
- methodName - A method name that is a candidate to be a final
method.
removeAllElementsFromListOfFinalMethodNames
public abstract void removeAllElementsFromListOfFinalMethodNames()
- Removes all the method name(s) from the list of method names
to be considered as final methods. After this method is called the
list of method names is empty.
selectFinalMethodName
public abstract void selectFinalMethodName(String methodName)
- Select a method name from the list of method names to be considered as
final methods. This method pre-selects a method name for the user.
The user has the option of changing this selection before initiating
morphing.
- Parameters:
- methodName - A method name.
getAdditionalClasses
public abstract String[] getAdditionalClasses()
- Gets the array of additional API class names to be added to the
dippable class.
- Returns:
-
null
if no additional APIs are to be added to the
new dippable class; otherwise a string with the list of
additional APIs class names.
getAdditionalInterfaces
public abstract String[] getAdditionalInterfaces()
- Gets the array of additional API interface names to be added to the
dippable class.
- Returns:
-
null
if no additional APIs are to be added to the
new dippable class; otherwise a string with the list of
additional APIs interface names.
addToListOfAdditionalInterfaces
public abstract void addToListOfAdditionalInterfaces(String interfaceName)
- Adds an interface name to the list of interfaces to be considered
as part of an additional API.
- Parameters:
- interfaceName - A package qualified interface name.
removeAllElementsFromListOfAdditionalInterfaces
public abstract void removeAllElementsFromListOfAdditionalInterfaces()
- Removes all the interface name(s) from the list of additional
interfaces. After this method is called the
list of additional interface names is empty.
setSaveToLocation
public abstract void setSaveToLocation(int state,
String location)
- Specifies where the dippable class will be saved.
- Parameters:
- state - Location constant.
- location
- The full path name of the location where the dippable class
will be saved.
- See Also:
- SAVE_TO_JAR, SAVE_TO_REPOS, SAVE_TO_ORIG, getSaveToState, getSaveToLocation
getSaveToState
public abstract int getSaveToState()
- Determines the location state indicating where the new dippable class
will be saved.
- Returns:
- The location constant.
- See Also:
- SAVE_TO_JAR, SAVE_TO_REPOS, SAVE_TO_ORIG, setSaveToLocation
getSaveToLocation
public abstract String getSaveToLocation()
- Determines the location where the new dippable class will be saved.
- Returns:
- The full path name of the location where the dippable class
will be saved.
- See Also:
- setSaveToLocation
setDoHideOriginal
public abstract void setDoHideOriginal(boolean state)
- Specifies whether the original bean should be marked as a "Java-Bean"
in the manifest of the repository that contains the new dippable class.
- Parameters:
- state -
true
if the original bean should not be marked
as a "Java-Bean"; false
otherwise.
getDoHideOriginal
public abstract boolean getDoHideOriginal()
- Determines whether the original bean should be marked as a "Java-Bean"
in the manifest of the repository that contains the new dippable class.
- Returns:
-
true
if the original bean should not be marked
as a "Java-Bean"; false
otherwise.
All Packages Class Hierarchy This Package Previous Next Index