RouterBuilder (patriot-framework 2.0.0 API)

java.lang.Object
- io.patriot_framework.network.simulator.api.builder.RouterBuilder

public class RouterBuilder
extends Object

The type RouterImpl builder.

Constructor Summary

Constructors
Constructor Description

RouterBuilder(TopologyBuilder topologyBuilder)
Instantiates a new RouterImpl builder.

RouterBuilder(String name)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TopologyBuilder`	`addRouters()`	Returns TopologyBuilder with created routers.
`Router`	`build()`
`RouterBuilder`	`createRouter()`	Create new router object and add it into topology routers.
`RouterBuilder`	`withCorner(Boolean corner)`
`RouterBuilder`	`withCreator(String creator)`
`RouterBuilder`	`withName(String name)`	Adds name to router.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RouterBuilder
```
public RouterBuilder(String name)
```
  - RouterBuilder
```
public RouterBuilder(TopologyBuilder topologyBuilder)
```
    Instantiates a new RouterImpl builder.
    
    Parameters:
    
    topologyBuilder - the topology builder
- Method Detail
  - withName
```
public RouterBuilder withName(String name)
```
    Adds name to router.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the router builder
  - withCreator
```
public RouterBuilder withCreator(String creator)
```
  - withCorner
```
public RouterBuilder withCorner(Boolean corner)
```
  - createRouter
```
public RouterBuilder createRouter()
```
    Create new router object and add it into topology routers.
    
    Returns:
    
    the router builder
  - addRouters
```
public TopologyBuilder addRouters()
```
    Returns TopologyBuilder with created routers.
    
    Returns:
    
    the topology builder
  - build
```
public Router build()
```