BridgeDescription.Builder (ONOS Java API (2.1.0))

All Known Implementing Classes:

DefaultBridgeDescription.Builder

Enclosing interface:

BridgeDescription
```
public static interface BridgeDescription.Builder
```
/** Builder of bridge description entities.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BridgeDescription`	`build()` Builds an immutable bridge description.
`BridgeDescription.Builder`	`controllers(List<ControllerInfo> controllers)` Returns bridge description builder with given controllers.
`BridgeDescription.Builder`	`controlProtocols(List<ControlProtocolVersion> controlProtocols)` Returns bridge description builder with given control protocol versions.
`BridgeDescription.Builder`	`datapathId(String datapathId)` Returns bridge description builder with a given datapath ID.
`BridgeDescription.Builder`	`datapathType(String datapathType)` Returns bridge description builder with a given datapath type.
`BridgeDescription.Builder`	`disableInBand()` Returns bridge description builder with in-band control disabled.
`BridgeDescription.Builder`	`enableLocalController()` Returns bridge description builder with local controller enabled.
`BridgeDescription.Builder`	`failMode(BridgeDescription.FailMode failMode)` Returns bridge description builder with a given fail mode.
`BridgeDescription.Builder`	`name(String name)` Returns bridge description builder with a given name.

- Method Detail
  - name
```
BridgeDescription.Builder name(String name)
```
    Returns bridge description builder with a given name.
    
    Parameters:
    
    name - bridge name
    
    Returns:
    
    bridge description builder
  - controllers
```
BridgeDescription.Builder controllers(List<ControllerInfo> controllers)
```
    Returns bridge description builder with given controllers.
    
    Parameters:
    
    controllers - set of controllers
    
    Returns:
    
    bridge description builder
  - enableLocalController
```
BridgeDescription.Builder enableLocalController()
```
    Returns bridge description builder with local controller enabled.
    
    Returns:
    
    bridge description builder
  - failMode
```
BridgeDescription.Builder failMode(BridgeDescription.FailMode failMode)
```
    Returns bridge description builder with a given fail mode.
    
    Parameters:
    
    failMode - fail mode
    
    Returns:
    
    bridge description builder
  - datapathId
```
BridgeDescription.Builder datapathId(String datapathId)
```
    Returns bridge description builder with a given datapath ID.
    
    Parameters:
    
    datapathId - datapath id
    
    Returns:
    
    bridge description builder
  - datapathType
```
BridgeDescription.Builder datapathType(String datapathType)
```
    Returns bridge description builder with a given datapath type.
    
    Parameters:
    
    datapathType - datapath type
    
    Returns:
    
    bridge description builder
  - controlProtocols
```
BridgeDescription.Builder controlProtocols(List<ControlProtocolVersion> controlProtocols)
```
    Returns bridge description builder with given control protocol versions.
    
    Parameters:
    
    controlProtocols - List of control protocol
    
    Returns:
    
    bridge description builder
  - disableInBand
```
BridgeDescription.Builder disableInBand()
```
    Returns bridge description builder with in-band control disabled.
    
    Returns:
    
    bridge description builder
  - build
```
BridgeDescription build()
```
    Builds an immutable bridge description.
    
    Returns:
    
    bridge description

Interface BridgeDescription.Builder

Method Summary

Method Detail

name

controllers

enableLocalController

failMode

datapathId

datapathType

controlProtocols

disableInBand

build