org.eclipse.stp.core.saf.handler
Class AbstractHandler

java.lang.Object
  extended byorg.eclipse.stp.core.saf.handler.AbstractHandler
All Implemented Interfaces:
IHandler
Direct Known Subclasses:
AbstractComponentHandler, AbstractEntryPointHandler, AbstractExternalServiceHandler, AbstractInterfaceHandler

public abstract class AbstractHandler
extends java.lang.Object
implements IHandler

This class provides common convenient methods for handler implementations.


Constructor Summary
AbstractHandler()
           
 
Method Summary
 java.lang.String getDescription()
          Returns text that describes the component, external service, entry point, or interface kind.
 java.lang.String getDescriptiveKindName()
          Returns a string describing the handler kind.
 java.lang.String getKind()
          Returns a string corresponding to a component, external service, entry point, or interface kind.
 java.net.URL getLargeIcon()
          Returns the URL for the large icon resource thet represents the corresponding component, entry point, external service, or interface kind.
 java.lang.String getName()
          Returns a name for the component, external service, entry point, or interface kind.
 java.net.URL getSmallIcon()
          Returns the URL for the small icon resource thet represents the corresponding component, entry point, external service, or interface kind.
 void initialize(java.lang.String kind, java.lang.String descKindName, java.lang.String name, java.lang.String description, java.net.URL smallIcon, java.net.URL largeIcon)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractHandler

public AbstractHandler()
Method Detail

initialize

public final void initialize(java.lang.String kind,
                             java.lang.String descKindName,
                             java.lang.String name,
                             java.lang.String description,
                             java.net.URL smallIcon,
                             java.net.URL largeIcon)

getKind

public final java.lang.String getKind()
Description copied from interface: IHandler
Returns a string corresponding to a component, external service, entry point, or interface kind. This string acts as an identifier for a component, external service, entry point, or interface handler (the handler registered to process the specified kind).

Specified by:
getKind in interface IHandler
Returns:
the QName string of the implementation kind of a component, or the binding kind of an external service or entry point, or an interface kind of an SCA interface

getDescriptiveKindName

public final java.lang.String getDescriptiveKindName()
Description copied from interface: IHandler
Returns a string describing the handler kind. This string is translated and is suitable for user dialogs and messages. For instance, if a given object can be processed by several different types of handlers, such as component and interface handlers, the user must be presented with a set of available choices. These choices can be worded using the descriptive kind name.

Specified by:
getDescriptiveKindName in interface IHandler
Returns:
the descriptive kind name for this handler

getName

public final java.lang.String getName()
Description copied from interface: IHandler
Returns a name for the component, external service, entry point, or interface kind. This string is intended to be suitable for display to an end user.

Specified by:
getName in interface IHandler
Returns:
the name of the implementation kind of a component, or the binding kind of an external service or entry point, or the interface kind of an SCA interface.

getDescription

public final java.lang.String getDescription()
Description copied from interface: IHandler
Returns text that describes the component, external service, entry point, or interface kind. This string is intended to be suitable for display to an end user.

Specified by:
getDescription in interface IHandler
Returns:
the description for the implementation kind of a component, or the binding kind of an external service or entry point, or the interface kind of an SCA interface

getSmallIcon

public final java.net.URL getSmallIcon()
Description copied from interface: IHandler
Returns the URL for the small icon resource thet represents the corresponding component, entry point, external service, or interface kind. The image is intended to be suitable for display to an end user.

Specified by:
getSmallIcon in interface IHandler
Returns:
URL for icon resource

getLargeIcon

public final java.net.URL getLargeIcon()
Description copied from interface: IHandler
Returns the URL for the large icon resource thet represents the corresponding component, entry point, external service, or interface kind. The image is intended to be suitable for display to an end user.

Specified by:
getLargeIcon in interface IHandler
Returns:
URL for icon resource