Module swim.api
Package swim.api.agent

Interface AgentRoute<A extends Agent>

All Superinterfaces:
AgentFactory<A>
All Known Implementing Classes:
AbstractAgentRoute
public interface AgentRoute<A extends Agent> extends AgentFactory<A>
Factory for agents that are lazily instantiated when a node URI route pattern is accessed.

  • Method Summary

    Modifier and Type
    Method
    Description
    AgentRouteContext
    agentRouteContext()
    The internal context used to provide concrete implementations to most AgentRoute methods.
    swim.uri.UriPattern
    pattern()
    The UriPattern that every nodeUri corresponding to an instance of A must match.
    String
    routeName()
    Returns a plane-unique identifier for this agent route.
    void
    setAgentRouteContext(AgentRouteContext context)
    Updates the internal context used to provide concrete implementations to most AgentRoute methods.

    Methods inherited from interface swim.api.agent.AgentFactory

    createAgent, id, props

  • Method Details

    • agentRouteContext

      AgentRouteContext agentRouteContext()
      The internal context used to provide concrete implementations to most AgentRoute methods.

    • setAgentRouteContext

      void setAgentRouteContext(AgentRouteContext context)
      Updates the internal context used to provide concrete implementations to most AgentRoute methods.

    • routeName

      String routeName()
      Returns a plane-unique identifier for this agent route.

    • pattern

      swim.uri.UriPattern pattern()
      The UriPattern that every nodeUri corresponding to an instance of A must match.