IpAssignment (ONOS Java API (1.12.0))

java.lang.Object
- org.onosproject.dhcp.IpAssignment

public final class IpAssignment
extends java.lang.Object

Stores the MAC ID to IP Address mapping details.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IpAssignment.AssignmentStatus

static class IpAssignment.Builder
IPAssignment Builder.

Nested Classes
Modifier and Type	Class and Description
`static class`	`IpAssignment.AssignmentStatus`
`static class`	`IpAssignment.Builder` IPAssignment Builder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IpAssignment.AssignmentStatus`	`assignmentStatus()` Returns the assignment status of the IP assignment.
`Ip4Address`	`broadcast()` Returns broadcast address of the IP assignment.
`static IpAssignment.Builder`	`builder()` Creates and returns a new builder instance.
`static IpAssignment.Builder`	`builder(IpAssignment assignment)` Creates and returns a new builder instance that clones an existing IPAssignment.
`Ip4Address`	`dhcpServer()` Returns dhcp server of the IP assignment.
`Ip4Address`	`domainServer()` Returns domain server address.
`Ip4Address`	`ipAddress()` Returns the IP Address of the IP assignment.
`int`	`leasePeriod()` Returns the lease period of the IP assignment.
`int`	`leasePeriodMs()` Returns the lease period of the IP assignment.
`Ip4Address`	`routerAddress()` Returns router address of the IP assignment.
`Ip4Address`	`subnetMask()` Returns subnet mask of the IP assignment.
`java.util.Date`	`timestamp()` Returns the timestamp of the IP assignment.
`java.lang.String`	`toString()`

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

- Method Detail
  - ipAddress
```
public Ip4Address ipAddress()
```
    Returns the IP Address of the IP assignment.
    
    Returns:
    
    the IP address
  - timestamp
```
public java.util.Date timestamp()
```
    Returns the timestamp of the IP assignment.
    
    Returns:
    
    the timestamp
  - assignmentStatus
```
public IpAssignment.AssignmentStatus assignmentStatus()
```
    Returns the assignment status of the IP assignment.
    
    Returns:
    
    the assignment status
  - leasePeriod
```
public int leasePeriod()
```
    Returns the lease period of the IP assignment.
    
    Returns:
    
    the lease period in seconds
  - leasePeriodMs
```
public int leasePeriodMs()
```
    Returns the lease period of the IP assignment.
    
    Returns:
    
    the lease period in milliseconds
  - subnetMask
```
public Ip4Address subnetMask()
```
    Returns subnet mask of the IP assignment.
    
    Returns:
    
    subnet mask
  - broadcast
```
public Ip4Address broadcast()
```
    Returns broadcast address of the IP assignment.
    
    Returns:
    
    broadcast address
  - dhcpServer
```
public Ip4Address dhcpServer()
```
    Returns dhcp server of the IP assignment.
    
    Returns:
    
    dhcp server ip address
  - routerAddress
```
public Ip4Address routerAddress()
```
    Returns router address of the IP assignment.
    
    Returns:
    
    router ip address
  - domainServer
```
public Ip4Address domainServer()
```
    Returns domain server address.
    
    Returns:
    
    domain server ip address
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - builder
```
public static IpAssignment.Builder builder()
```
    Creates and returns a new builder instance.
    
    Returns:
    
    new builder
  - builder
```
public static IpAssignment.Builder builder(IpAssignment assignment)
```
    Creates and returns a new builder instance that clones an existing IPAssignment.
    
    Parameters:
    
    assignment - ip address assignment
    
    Returns:
    
    new builder

Class IpAssignment

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

ipAddress

timestamp

assignmentStatus

leasePeriod

leasePeriodMs

subnetMask

broadcast

dhcpServer

routerAddress

domainServer

toString

builder

builder