Eclipse RSE Development Guide (Galileo) - AbstractService (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.services
Class AbstractService


java.lang.Object
  

org.eclipse.core.runtime.PlatformObject
      
org.eclipse.rse.services.AbstractService

All Implemented Interfaces:: IAdaptable, IService

Direct Known Subclasses:: AbstractDStoreService, AbstractFileService, AbstractProcessService, AbstractSearchService, AbstractShellService, AbstractTerminalService

public abstract class AbstractService
extends PlatformObject
implements IService
extends PlatformObject
implements IService

Abstract default implementation of an RSE Service. Clients are expected to extend this class.

Since:: org.eclipse.rse.services 3.0
See Also:: IService

Constructor Summary

AbstractService ()


Method Summary

String getDescription ()
          Get the description of this Service as a translated, UI-visible String.

String getName ()
          Get the name of this Service as a translated, UI-visible String.

void initService ( IProgressMonitor monitor)
          Default implementation of initService.

void uninitService ( IProgressMonitor monitor)
          Default implementation of uninitService.

Methods inherited from class org.eclipse.core.runtime. PlatformObject

getAdapter

Methods inherited from class java.lang. Object

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

Methods inherited from interface org.eclipse.core.runtime. IAdaptable

getAdapter

Constructor Detail

AbstractService

public AbstractService()

Method Detail

getDescription

public 
String getDescription()

Description copied from interface: IService

Get the description of this Service as a translated, UI-visible String. Extenders are expected to override this method.

Specified by:: getDescription in interface IService

Returns:: the description of this Service.

getName

public 
String getName()

Description copied from interface: IService

Get the name of this Service as a translated, UI-visible String. Extenders are expected to override this method.

Specified by:: getName in interface IService

Returns:: the name of this Service.

initService

public void initService(
IProgressMonitor monitor)
                 throws 
SystemMessageException

Default implementation of initService. Extenders who override this method must call super.initService(monitor) as the first call in their implementation.

Specified by:: initService in interface IService

Parameters:: monitor - A progress monitor to provide progress of long-running operation. There is no guarantee that cancellation is actually supported by a Service since it would leave the service in a potentially inconsistent, partially initialized state.
Throws:: SystemMessageException - if an error occurs during initialization.

uninitService

public void uninitService(
IProgressMonitor monitor)

Default implementation of uninitService. Extenders who override this method must call super.uninitService(monitor) as the last call in their implementation.

Specified by:: uninitService in interface IService

Parameters:: monitor - A progress monitor to provide progress of long-running operation. There is no guarantee that cancellation is actually supported by a Service since it would leave the service in a potentially inconsistent, partially initialized state.