Interface Component<D extends ComponentDescriptor,E extends ServerEnvironment>

All Known Subinterfaces:
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

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

    • 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