DeviceInterfaceDescription (ONOS Java API (2.2.5))

All Known Implementing Classes:

DefaultDeviceInterfaceDescription
```
public interface DeviceInterfaceDescription
```
The description of an interface used for legacy devices.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class DeviceInterfaceDescription.Mode
Represents the type of operation of the interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`isRateLimited()`	Indicates whether a rate limit has been set on the interface.
`DeviceInterfaceDescription.Mode`	`mode()`	Returns the operation mode of the interface.
`java.lang.String`	`name()`	Returns the name of the interface.
`short`	`rateLimit()`	Returns the rate limit set on the interface bandwidth.
`java.util.List<VlanId>`	`vlans()`	Returns the VLAN-IDs configured for the interface.

- Method Detail
  - name
```
java.lang.String name()
```
    Returns the name of the interface.
    
    Returns:
    
    name of the interface
  - mode
```
DeviceInterfaceDescription.Mode mode()
```
    Returns the operation mode of the interface.
    
    Returns:
    
    operation mode of the interface
  - vlans
```
java.util.List<VlanId> vlans()
```
    Returns the VLAN-IDs configured for the interface. No VLAN-ID should be returned for NORMAL mode, 1 VLAN-ID for access mode and 1 or more VLAN-IDs for trunking mode.
    
    Returns:
    
    VLAN-ID(s) configured for the interface.
  - isRateLimited
```
boolean isRateLimited()
```
    Indicates whether a rate limit has been set on the interface.
    
    Returns:
    
    indication whether interface is rate limited or not
  - rateLimit
```
short rateLimit()
```
    Returns the rate limit set on the interface bandwidth.
    
    Returns:
    
    the rate limit set on the interface bandwidth