Module swim.api

Package swim.api.agent

Class AbstractAgentRoute<A extends Agent>

java.lang.Object

swim.api.agent.AbstractAgentRoute<A>

All Implemented Interfaces:

AgentFactory<A>, AgentRoute<A>

Direct Known Subclasses:

JavaAgentFactory, JsAgentFactory

public abstract class AbstractAgentRoute<A extends Agent>
extends Object
implements AgentRoute<A>

Field Summary

Fields

Modifier and Type	Field	Description
protected AgentRouteContext	context

Constructor Summary

Constructors

Constructor	Description
AbstractAgentRoute()

Method Summary

Modifier and Type	Method	Description
AgentRouteContext	agentRouteContext()	The internal context used to provide concrete implementations to most AgentRoute methods.
abstract A	createAgent(AgentContext context)	Creates an instance of A with internal context context.
UriPattern	pattern()	The UriPattern that every nodeUri corresponding to an instance of A must match.
Value	props(Uri nodeUri)
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 class java.lang.Object

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

Methods inherited from interface swim.api.agent.AgentFactory

id

Field Details

context

protected AgentRouteContext context

Constructor Details

AbstractAgentRoute

public AbstractAgentRoute()

Method Details

agentRouteContext

public AgentRouteContext agentRouteContext()

Description copied from interface: AgentRoute

The internal context used to provide concrete implementations to most AgentRoute methods.

Specified by:

agentRouteContext in interface AgentRoute<A extends Agent>

setAgentRouteContext

public void setAgentRouteContext(AgentRouteContext context)

Description copied from interface: AgentRoute

Updates the internal context used to provide concrete implementations to most AgentRoute methods.

Specified by:

setAgentRouteContext in interface AgentRoute<A extends Agent>

routeName

public String routeName()

Description copied from interface: AgentRoute

Returns a plane-unique identifier for this agent route.

Specified by:

routeName in interface AgentRoute<A extends Agent>

pattern

public UriPattern pattern()

Description copied from interface: AgentRoute

The UriPattern that every nodeUri corresponding to an instance of A must match.

Specified by:

pattern in interface AgentRoute<A extends Agent>

createAgent

public abstract A createAgent(AgentContext context)

Description copied from interface: AgentFactory

Creates an instance of A with internal context context.

Specified by:

createAgent in interface AgentFactory<A extends Agent>

props

public Value props(Uri nodeUri)

Specified by:

props in interface AgentFactory<A extends Agent>