Ipv4Interval (ip-resource 1.4.7 API)

java.lang.Object
- com.bol.ipresource.ip.IpInterval<Ipv4Interval>
- - com.bol.ipresource.ip.Ipv4Interval

All Implemented Interfaces:

Interval<Ipv4Interval>, Comparable<Ipv4Interval>
```
public class Ipv4Interval
extends IpInterval<Ipv4Interval>
implements Comparable<Ipv4Interval>
```
Efficient representation of an IPv4 address range. Internally IPv4 addresses are stored as signed 32-bit ints. Externally they are represented as longs to avoid issues with the sign-bit.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`IPV4_DOTLESS_REVERSE_DOMAIN`
`static String`	`IPV4_REVERSE_DOMAIN`
`static Ipv4Interval`	`MAX_RANGE` The IPv4 interval that includes all IPv4 addresses (0.0.0.0/0 in CIDR notation).

Constructor Summary

Constructors
Constructor and Description

Ipv4Interval(long begin, long end)
Constructs a new IPv4 interval with the specified begin and end (both inclusive).

Constructors
Constructor and Description
`Ipv4Interval(long begin, long end)` Constructs a new IPv4 interval with the specified begin and end (both inclusive).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`begin()`
`String`	`beginAddressAsString()`
`byte[]`	`beginAsByteArray()`
`InetAddress`	`beginAsInetAddress()`
`int`	`compareTo(Ipv4Interval that)` Orders on `begin` ASCENDING and `end` DESCENDING.
`int`	`compareUpperBound(Ipv4Interval that)` Compare two intervals based on their upper-bounds.
`boolean`	`contains(Ipv4Interval that)` Tests if this interval contains `that`.
`long`	`end()`
`String`	`endAddressAsString()`
`byte[]`	`endAsByteArray()`
`InetAddress`	`endAsInetAddress()`
`boolean`	`equals(Object obj)`
`int`	`getPrefixLength()`
`int`	`hashCode()`
`boolean`	`intersects(Ipv4Interval that)` Tests if these two intervals intersect.
`static String`	`numericToTextFormat(int src)`
`static Ipv4Interval`	`parse(InetAddress inetAddress)`
`static Ipv4Interval`	`parse(String resource)`
`static Ipv4Interval`	`parseIpAddress(String ipAddress)`
`static Ipv4Interval`	`parsePrefixWithLength(long prefix, int prefixLength)`
`static Ipv4Interval`	`parseReverseDomain(String address)`
`Ipv4Interval`	`singletonIntervalAtLowerBound()` Copies this interval into a new interval that has both its lower and upper-bound set to the original's lower-bound.
`static int`	`textToNumericFormat(String src)`
`String`	`toPrefixString()`
`String`	`toRangeString()`
`String`	`toReverseDomain()`
`String`	`toString()`

Methods inherited from class com.bol.ipresource.ip.IpInterval
asIpInterval, valueOf

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

- Field Detail
  - IPV4_DOTLESS_REVERSE_DOMAIN
```
public static final String IPV4_DOTLESS_REVERSE_DOMAIN
```
    See Also:
    
    Constant Field Values
  - IPV4_REVERSE_DOMAIN
```
public static final String IPV4_REVERSE_DOMAIN
```
    See Also:
    
    Constant Field Values
  - MAX_RANGE
```
public static final Ipv4Interval MAX_RANGE
```
    The IPv4 interval that includes all IPv4 addresses (0.0.0.0/0 in CIDR notation).
- Constructor Detail
  - Ipv4Interval
```
public Ipv4Interval(long begin,
                    long end)
```
    Constructs a new IPv4 interval with the specified begin and end (both inclusive).
    
    Parameters:
    
    begin - the first IPv4 address in this address range (inclusive).
    
    end - the last IPv4 address in this address range (inclusive).
    
    Throws:
    
    IllegalArgumentException - if the start or end addresses are invalid or if the start address is greater than the end address.
- Method Detail
  - parse
```
public static Ipv4Interval parse(InetAddress inetAddress)
```
  - parse
```
public static Ipv4Interval parse(String resource)
```
  - parseIpAddress
```
public static Ipv4Interval parseIpAddress(String ipAddress)
```
  - parsePrefixWithLength
```
public static Ipv4Interval parsePrefixWithLength(long prefix,
                                                 int prefixLength)
```
  - parseReverseDomain
```
public static Ipv4Interval parseReverseDomain(String address)
```
  - begin
```
public long begin()
```
    Returns:
    
    the start address as "unsigned" long.
  - end
```
public long end()
```
    Returns:
    
    the end address as "unsigned" long.
  - contains
```
public boolean contains(Ipv4Interval that)
```
    Description copied from interface: Interval
    
    Tests if this interval contains that. Note that if two intervals are equal, they also contain each other (and vice versa). An interval always contains itself.
    
    Specified by:
    
    contains in interface Interval<Ipv4Interval>
    
    Parameters:
    
    that - the interval to test for containment
    
    Returns:
    
    true if this contains that interval
  - intersects
```
public boolean intersects(Ipv4Interval that)
```
    Description copied from interface: Interval
    
    Tests if these two intervals intersect. Two intervals intersect if there exists a point which is contained within both intervals. An interval always intersects itself.
    
    Specified by:
    
    intersects in interface Interval<Ipv4Interval>
    
    Parameters:
    
    that - the other interval to test for intersection
    
    Returns:
    
    true if this interval intersects that interval
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - numericToTextFormat
```
public static String numericToTextFormat(int src)
```
  - textToNumericFormat
```
public static int textToNumericFormat(String src)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toRangeString
```
public String toRangeString()
```
    Specified by:
    
    toRangeString in class IpInterval<Ipv4Interval>
  - toPrefixString
```
public String toPrefixString()
```
    Specified by:
    
    toPrefixString in class IpInterval<Ipv4Interval>
  - toReverseDomain
```
public String toReverseDomain()
```
    Specified by:
    
    toReverseDomain in class IpInterval<Ipv4Interval>
  - beginAddressAsString
```
public String beginAddressAsString()
```
    Specified by:
    
    beginAddressAsString in class IpInterval<Ipv4Interval>
  - endAddressAsString
```
public String endAddressAsString()
```
    Specified by:
    
    endAddressAsString in class IpInterval<Ipv4Interval>
  - compareTo
```
public int compareTo(Ipv4Interval that)
```
    Orders on begin ASCENDING and end DESCENDING. This puts less-specific ranges before more-specific ranges.
    
    Specified by:
    
    compareTo in interface Comparable<Ipv4Interval>
  - singletonIntervalAtLowerBound
```
public Ipv4Interval singletonIntervalAtLowerBound()
```
    Description copied from interface: Interval
    Copies this interval into a new interval that has both its lower and upper-bound set to the original's lower-bound. This is used to be able to compare an interval's lower-bound with another interval's upper-bound.
```
   Interval a = ...
   Interval b = ...
   if (a.singletonIntervalAtLowerBound().compareUpperBoundTo(b) < 0) ...
 
```
    Specified by:
    
    singletonIntervalAtLowerBound in interface Interval<Ipv4Interval>
    
    Returns:
    
    a new interval that has both its lower- and upper-bound set to this interval's lower-bound
  - compareUpperBound
```
public int compareUpperBound(Ipv4Interval that)
```
    Description copied from interface: Interval
    
    Compare two intervals based on their upper-bounds. This is used by the NestedIntervalMap implementation to quickly find two potentially intersecting intervals by ordering intervals on the upper-bound and searching based on the lower-bound.
    
    Specified by:
    
    compareUpperBound in interface Interval<Ipv4Interval>
    
    Parameters:
    
    that - the interval to compare the upper-bound with
    
    Returns:
    
    <0 if this upper-bound is less than that upper-bound,
    =0 if this upper-bound equals that upper-bound,
    >0 if this upper-bound is greater than that upper-bound
  - beginAsInetAddress
```
public InetAddress beginAsInetAddress()
```
    Specified by:
    
    beginAsInetAddress in class IpInterval<Ipv4Interval>
  - endAsInetAddress
```
public InetAddress endAsInetAddress()
```
    Specified by:
    
    endAsInetAddress in class IpInterval<Ipv4Interval>
  - beginAsByteArray
```
public byte[] beginAsByteArray()
```
    Specified by:
    
    beginAsByteArray in class IpInterval<Ipv4Interval>
  - endAsByteArray
```
public byte[] endAsByteArray()
```
    Specified by:
    
    endAsByteArray in class IpInterval<Ipv4Interval>
  - getPrefixLength
```
public int getPrefixLength()
```
    Specified by:
    
    getPrefixLength in class IpInterval<Ipv4Interval>

Class Ipv4Interval

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.bol.ipresource.ip.IpInterval

Methods inherited from class java.lang.Object

Field Detail

IPV4_DOTLESS_REVERSE_DOMAIN

IPV4_REVERSE_DOMAIN

MAX_RANGE

Constructor Detail

Ipv4Interval

Method Detail

parse

parse

parseIpAddress

parsePrefixWithLength

parseReverseDomain

begin

end

contains

intersects

hashCode

equals

numericToTextFormat

textToNumericFormat

toString

toRangeString

toPrefixString

toReverseDomain

beginAddressAsString

endAddressAsString

compareTo

singletonIntervalAtLowerBound

compareUpperBound

beginAsInetAddress

endAsInetAddress

beginAsByteArray

endAsByteArray

getPrefixLength