DefaultPatchDescription (ONOS Java API (2.5.0))

java.lang.Object
- org.onosproject.net.AbstractDescription
- - org.onosproject.net.behaviour.DefaultPatchDescription

All Implemented Interfaces:

Annotated, PatchDescription, Description
```
public final class DefaultPatchDescription
extends AbstractDescription
implements PatchDescription
```
Default implementation of immutable patch interface description entity.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DefaultPatchDescription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DefaultPatchDescription.Builder`	`builder()`	Returns new builder instance.
`Optional<String>`	`deviceId()`	Returns the identifier of the device where this patch interface is.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`String`	`ifaceName()`	Return the name of the patch interface.
`String`	`peer()`	Returns the name of the interface for the other side of the patch.
`String`	`toString()`

Methods inherited from class org.onosproject.net.AbstractDescription
annotations

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

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

- Method Detail
  - deviceId
```
public Optional<String> deviceId()
```
    Description copied from interface: PatchDescription
    
    Returns the identifier of the device where this patch interface is.
    
    Specified by:
    
    deviceId in interface PatchDescription
    
    Returns:
    
    device identifier; empty value if not set
  - ifaceName
```
public String ifaceName()
```
    Description copied from interface: PatchDescription
    
    Return the name of the patch interface.
    
    Specified by:
    
    ifaceName in interface PatchDescription
    
    Returns:
    
    patch interface name
  - peer
```
public String peer()
```
    Description copied from interface: PatchDescription
    
    Returns the name of the interface for the other side of the patch.
    
    Specified by:
    
    peer in interface PatchDescription
    
    Returns:
    
    peer patch interface name
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractDescription
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AbstractDescription
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - builder
```
public static DefaultPatchDescription.Builder builder()
```
    Returns new builder instance.
    
    Returns:
    
    default patch description builder