PatchDescription (ONOS Java API (2.2.4))

All Superinterfaces:

Annotated, Description

All Known Implementing Classes:

DefaultPatchDescription
```
public interface PatchDescription
extends Description, Annotated
```
Describes a patch interface.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface PatchDescription.Builder
Builder of patch interface description entities.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.util.Optional<java.lang.String>`	`deviceId()`	Returns the identifier of the device where this patch interface is.
`java.lang.String`	`ifaceName()`	Return the name of the patch interface.
`java.lang.String`	`peer()`	Returns the name of the interface for the other side of the patch.

Methods inherited from interface org.onosproject.net.Description
annotations

- Method Detail
  - deviceId
```
java.util.Optional<java.lang.String> deviceId()
```
    Returns the identifier of the device where this patch interface is.
    
    Returns:
    
    device identifier; empty value if not set
  - ifaceName
```
java.lang.String ifaceName()
```
    Return the name of the patch interface.
    
    Returns:
    
    patch interface name
  - peer
```
java.lang.String peer()
```
    Returns the name of the interface for the other side of the patch.
    
    Returns:
    
    peer patch interface name