Module swim.js
Package swim.js

Class JsAgent

java.lang.Object
swim.js.JsAgent
All Implemented Interfaces:
Agent, GuestWrapper
public class JsAgent extends Object implements Agent, GuestWrapper

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final AgentContext
    agentContext
     
    protected final JsBridge
    bridge
     
    protected final Object
    guest
     
    protected final JsModule
    module
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    JsAgent(AgentContext agentContext, JsBridge bridge, JsModule module, Object guest)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final AgentContext
    agentContext()
    Returns the AgentContext used to manage this Agent.
    final JsBridge
    bridge()
     
    void
    didClose()
    Lifecycle callback invoked immediately after this Agent closes.
    void
    didFail(Throwable error)
    Lifecycle callback invoked immediately after this Agent throws error.
    void
    didLoad()
    Lifecycle callback invoked immediately after this Agent loads, i.e.
    void
    didOpen()
    Lifecycle callback invoked immediately after this Agent opens, i.e.
    void
    didStart()
    Lifecycle callback invoked immediately after this Agent starts.
    void
    didStop()
    Lifecycle callback invoked immediately after this Agent stops, i.e.
    void
    didUnload()
    Lifecycle callback invoked immediately after this Agent unloads, i.e.
    final JsModule
    module()
     
    final Object
    unwrap()
    Returns the guest value that this host object wraps.
    void
    willClose()
    Lifecycle callback invoked immediately before this Agent closes.
    void
    willLoad()
    Lifecycle callback invoked immediately before this Agent loads.
    void
    willOpen()
    Lifecycle callback invoked immediately before this Agent opens.
    void
    willStart()
    Lifecycle callback invoked immediately before this Agent starts.
    void
    willStop()
    Lifecycle callback invoked immediately before this Agent stops.
    void
    willUnload()
    Lifecycle callback invoked immediately before this Agent unloads.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • agentContext

      protected final AgentContext agentContext

    • bridge

      protected final JsBridge bridge

    • module

      protected final JsModule module

    • guest

      protected final Object guest

  • Constructor Details

  • Method Details

    • agentContext

      public final AgentContext agentContext()
      Description copied from interface: Agent
      Returns the AgentContext used to manage this Agent.
      Specified by:
      agentContext in interface Agent

    • bridge

      public final JsBridge bridge()

    • module

      public final JsModule module()

    • unwrap

      public final Object unwrap()
      Description copied from interface: GuestWrapper
      Returns the guest value that this host object wraps.
      Specified by:
      unwrap in interface GuestWrapper

    • willOpen

      public void willOpen()
      Description copied from interface: Agent
      Lifecycle callback invoked immediately before this Agent opens.

      //@see swim.system.TierBinding#open

      Specified by:
      willOpen in interface Agent

    • didOpen

      public void didOpen()
      Description copied from interface: Agent
      Lifecycle callback invoked immediately after this Agent opens, i.e. before it loads.

      //@see swim.system.TierBinding#open //@see swim.system.TierBinding#load

      Specified by:
      didOpen in interface Agent

    • willLoad

      public void willLoad()
      Description copied from interface: Agent
      Lifecycle callback invoked immediately before this Agent loads.

      //@see swim.system.TierBinding#load

      Specified by:
      willLoad in interface Agent

    • didLoad

      public void didLoad()
      Description copied from interface: Agent
      Lifecycle callback invoked immediately after this Agent loads, i.e. before it starts.

      //@see swim.system.TierBinding#load //@see swim.system.TierBinding#start

      Specified by:
      didLoad in interface Agent

    • willStart

      public void willStart()
      Description copied from interface: Agent
      Lifecycle callback invoked immediately before this Agent starts.

      //@see swim.system.TierBinding#start

      Specified by:
      willStart in interface Agent

    • didStart

      public void didStart()
      Description copied from interface: Agent
      Lifecycle callback invoked immediately after this Agent starts.

      //@see swim.system.TierBinding#start

      Specified by:
      didStart in interface Agent

    • willStop

      public void willStop()
      Description copied from interface: Agent
      Lifecycle callback invoked immediately before this Agent stops.

      //@see swim.system.TierBinding#stop

      Specified by:
      willStop in interface Agent

    • didStop

      public void didStop()
      Description copied from interface: Agent
      Lifecycle callback invoked immediately after this Agent stops, i.e. before it unloads.

      //@see swim.system.TierBinding#stop //@see swim.system.TierBinding#unload

      Specified by:
      didStop in interface Agent

    • willUnload

      public void willUnload()
      Description copied from interface: Agent
      Lifecycle callback invoked immediately before this Agent unloads.

      //@see swim.system.TierBinding#unload

      Specified by:
      willUnload in interface Agent

    • didUnload

      public void didUnload()
      Description copied from interface: Agent
      Lifecycle callback invoked immediately after this Agent unloads, i.e. before it closes.

      //@see swim.system.TierBinding.unload //@see swim.system.TierBinding.close

      Specified by:
      didUnload in interface Agent

    • willClose

      public void willClose()
      Description copied from interface: Agent
      Lifecycle callback invoked immediately before this Agent closes.

      //@see swim.system.TierBinding.close

      Specified by:
      willClose in interface Agent

    • didClose

      public void didClose()
      Description copied from interface: Agent
      Lifecycle callback invoked immediately after this Agent closes.

      //@see swim.system.TierBinding.close

      Specified by:
      didClose in interface Agent

    • didFail

      public void didFail(Throwable error)
      Description copied from interface: Agent
      Lifecycle callback invoked immediately after this Agent throws error.
      Specified by:
      didFail in interface Agent