VtnPort.Builder (onos-apps-xosclient)

java.lang.Object
- org.onosproject.xosclient.api.VtnPort.Builder

Enclosing class:: VtnPort

public static final class VtnPort.Builder
extends Object

Builder of VTN port entities.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VtnPort.Builder`	`addressPairs(Map<org.onlab.packet.IpAddress,org.onlab.packet.MacAddress> addressPairs)` Returns VTN port builder with the supplied address pairs.
`VtnPort`	`build()` Builds an immutable VTN port.
`VtnPort.Builder`	`id(VtnPortId id)` Returns VTN port builder with the supplied port ID.
`VtnPort.Builder`	`ip(org.onlab.packet.IpAddress ip)` Returns VTN port builder with the supplied IP address.
`VtnPort.Builder`	`ip(String ip)` Returns VTN port builder with the supplied IP address.
`VtnPort.Builder`	`mac(org.onlab.packet.MacAddress mac)` Returns VTN port builder with the supplied MAC address.
`VtnPort.Builder`	`mac(String mac)` Returns VTN port builder with the supplied MAC address.
`VtnPort.Builder`	`name(String name)` Returns VTN port builder with the supplied port name.
`VtnPort.Builder`	`serviceId(VtnServiceId serviceId)` Returns VTN port builder with the supplied service ID.

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

- Method Detail
  - build
```
public VtnPort build()
```
    Builds an immutable VTN port.
    
    Returns:
    
    vtn port instance
  - id
```
public VtnPort.Builder id(VtnPortId id)
```
    Returns VTN port builder with the supplied port ID.
    
    Parameters:
    
    id - port identifier
    
    Returns:
    
    vtn port builder
  - name
```
public VtnPort.Builder name(String name)
```
    Returns VTN port builder with the supplied port name. Port name can be null.
    
    Parameters:
    
    name - port name
    
    Returns:
    
    vtn port builder
  - serviceId
```
public VtnPort.Builder serviceId(VtnServiceId serviceId)
```
    Returns VTN port builder with the supplied service ID.
    
    Parameters:
    
    serviceId - vtn port service id
    
    Returns:
    
    vtn port builder
  - mac
```
public VtnPort.Builder mac(org.onlab.packet.MacAddress mac)
```
    Returns VTN port builder with the supplied MAC address.
    
    Parameters:
    
    mac - mac address
    
    Returns:
    
    vtn port builder
  - mac
```
public VtnPort.Builder mac(String mac)
```
    Returns VTN port builder with the supplied MAC address.
    
    Parameters:
    
    mac - mac address as a string
    
    Returns:
    
    vtn port builder
  - ip
```
public VtnPort.Builder ip(org.onlab.packet.IpAddress ip)
```
    Returns VTN port builder with the supplied IP address.
    
    Parameters:
    
    ip - ip address
    
    Returns:
    
    vtn port builder
  - ip
```
public VtnPort.Builder ip(String ip)
```
    Returns VTN port builder with the supplied IP address.
    
    Parameters:
    
    ip - ip address as a string
    
    Returns:
    
    vtn port builder
  - addressPairs
```
public VtnPort.Builder addressPairs(Map<org.onlab.packet.IpAddress,org.onlab.packet.MacAddress> addressPairs)
```
    Returns VTN port builder with the supplied address pairs.
    
    Parameters:
    
    addressPairs - address pairs
    
    Returns:
    
    vtn port builder

Class VtnPort.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

build

id

name

serviceId

mac

mac

ip

ip

addressPairs