Package jmri.server.web.spi

Class AngularRoute

java.lang.Object

jmri.server.web.spi.AngularRoute

public final class AngularRoute
extends Object

Constructor Summary

Constructors

Constructor	Description
AngularRoute(String when, String template, String controller, String redirection)	Create an AngularJS route.

Method Summary

Modifier and Type	Method	Description
String	getController()	Get the AngularJS controller for the route.
String	getRedirection()
String	getTemplate()	Get the HTML template for the route.
String	getWhen()

Methods inherited from class java.lang.Object

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

Constructor Details

AngularRoute

public AngularRoute(@Nonnull
 String when,
 @CheckForNull
 String template,
 @CheckForNull
 String controller,
 @CheckForNull
 String redirection)

Create an AngularJS route.

Parameters:

when - the trigger for the route

template - the template loaded for the route; must be non-null if controller is non-null

controller - the controller loaded for the route; must be non-null if template is non-null

redirection - the path to redirect the route to; must be non-null if template and controller is null; must be null if template and controller is non-null

Throws:

NullPointerException - if when is null

IllegalArgumentException - if any of the rules concerning when template, controller, and redirection must be non-null are violated

Method Details

getRedirection

@CheckForNull
public String getRedirection()

getWhen

@Nonnull
public String getWhen()

getTemplate

@CheckForNull
public String getTemplate()

Get the HTML template for the route.

Returns:

the template or null

getController

@CheckForNull
public String getController()

Get the AngularJS controller for the route.

Returns:

the controller or null