Interface AdapterExtension

  • All Implemented Interfaces:

    
    public interface AdapterExtension
    
                        

    This interface represents an extension for adapters in the Scorpio API. Implementations of this interface must provide functionality for handling messages and managing the adapter's lifecycle.

    Since:

    1.1.0

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract String getIdentifier() Returns a unique identifier for this adapter extension.
      abstract Unit handleMessage(PlayerMessage message) Handles a PlayerMessage received from the bridge plugin
      abstract Boolean getStatus() Retrieves the current status of the adapter.
      abstract Unit shutdown() Shuts down the adapter, releasing any resources and stopping operations.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getIdentifier

         abstract String getIdentifier()

        Returns a unique identifier for this adapter extension.

        Returns:

        the identifier as a String

        Since:

        1.1.0

      • getStatus

         abstract Boolean getStatus()

        Retrieves the current status of the adapter.

        Returns:

        true if the adapter is active, false otherwise

        Since:

        1.1.0

      • shutdown

         abstract Unit shutdown()

        Shuts down the adapter, releasing any resources and stopping operations.

        Since:

        1.1.0