de.espirit.firstspirit.module

Interface Component<D extends ComponentDescriptor,E extends ServerEnvironment>

All Known Subinterfaces:

Editor<E>, Library<E>, ProjectApp, Service<T>, WebApp, WebServer

All Known Implementing Classes:

AbstractWebApp

public interface Component<D extends ComponentDescriptor,E extends ServerEnvironment>

Super interface for all FIRSTspirit Components. Implementing classes must have a no-arg constructor.

Since:

4.1

Method Summary

Methods

Modifier and Type	Method and Description
void	init(D descriptor, E env) Initializes this component with the given descriptor and environment.
void	installed() Event method: called if Component was successfully installed (not updated!)
void	uninstalling() Event method: called if Component was in uninstalling procedure
void	updated(String oldVersionString) Event method: called if Component was completely updated

Method Detail

init

void init(D descriptor,
        E env)

Initializes this component with the given descriptor and environment. No other method will be called before the component is initialized!

Parameters:

descriptor - useful descriptor information for this component.

env - useful environment information for this component.

Since:

4.1

installed

void installed()

Event method: called if Component was successfully installed (not updated!)

Since:

4.1

uninstalling

void uninstalling()

Event method: called if Component was in uninstalling procedure

Since:

4.1

updated

void updated(String oldVersionString)

Event method: called if Component was completely updated

Parameters:

oldVersionString - old version, before component was updated

Since:

4.1