IPTable (DSpace Kernel :: API and Implementation 7.1.1 API)

java.lang.Object
- org.dspace.statistics.util.IPTable

```
public class IPTable
extends Object
```
A Spare v4 IPTable implementation that uses nested HashMaps to optimize IP address matching over ranges of IP addresses.

Author:

mdiggory at atmire.com

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class IPTable.IPFormatException
Exception Class to deal with IPFormat errors.

Constructor Summary

Constructors
Constructor Description

IPTable()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`add(String ip)`	Can be full v4 IP, subnet or range string.
`boolean`	`contains(String ip)`	Check whether a given address is contained in this netblock.
`boolean`	`isEmpty()`	Return whether IPTable is empty (having no entries)
`Set<String>`	`toSet()`	Convert to a Set.

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

- Constructor Detail
  - IPTable
```
public IPTable()
```
- Method Detail
  - add
```
public void add(String ip)
         throws IPTable.IPFormatException
```
    Can be full v4 IP, subnet or range string.
    
    A full address is a complete dotted-quad: "1.2.3.4".
    A subnet is a dotted-triplet: "1.2.3". It means an entire Class C subnet: "1.2.3.0-1.2.3.255".
    A range is two dotted-quad addresses separated by hyphen: "1.2.3.4-1.2.3.14". Only the final octet may be different.
    Any attempt at CIDR notation is ignored.
    Parameters:
    
    ip - IP address(es)
    
    Throws:
    
    IPTable.IPFormatException - Exception Class to deal with IPFormat errors.
  - contains
```
public boolean contains(String ip)
                 throws IPTable.IPFormatException
```
    Check whether a given address is contained in this netblock.
    
    Parameters:
    
    ip - the address to be tested
    
    Returns:
    
    true if ip is within this table's limits. Returns false if ip looks like an IPv6 address.
    
    Throws:
    
    IPTable.IPFormatException - Exception Class to deal with IPFormat errors.
  - toSet
```
public Set<String> toSet()
```
    Convert to a Set.
    
    Returns:
    
    this table's content as a Set
  - isEmpty
```
public boolean isEmpty()
```
    Return whether IPTable is empty (having no entries)
    
    Returns:
    
    true if empty, false otherwise