IPAddress (ineter 0.1.2 API)

java.lang.Object
- com.github.maltalex.ineter.base.IPAddress

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

IPv4Address, IPv6Address
```
public abstract class IPAddress
extends java.lang.Object
implements java.io.Serializable
```
Abstract class that represents a single IP address

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

IPAddress()

Constructors
Constructor and Description
`IPAddress()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract boolean`	`is6To4()` Checks whether the given address is a 6to4 address
`abstract boolean`	`isLinkLocal()` Checks whether the address is link-local
`abstract boolean`	`isLoopback()` Checks whether the address is a loopback address
`abstract boolean`	`isMartian()` Martian addresses are reserved and private addresses that should not appear on the public internet
`abstract boolean`	`isMulticast()` Checks whether the address is part of a range reserved for multicast
`abstract boolean`	`isPrivate()` Checks whether the address is private
`abstract boolean`	`isReserved()` Checks whether the address part of a reserved range
`abstract boolean`	`isUnspecified()` Checks whether the address is "unspecified"
`abstract IPAddress`	`minus(int n)` Return an address smaller than the current one by n, with wraparound
`abstract IPAddress`	`next()` Returns the following address, with wraparound
`static IPAddress`	`of(byte[] bigEndianByteArr)` Returns either an IPv4 or an IPv6 address
`static IPAddress`	`of(java.net.InetAddress address)` Returns either an IPv4 or an IPv6 address built from an InetAddress
`static IPAddress`	`of(java.lang.String ip)` Returns either an IPv4 or an IPv6 address
`abstract IPAddress`	`plus(int n)` Return an address larger than the current one by n, with wraparound
`abstract IPAddress`	`previous()` Returns the previous address, with wraparound
`byte[]`	`toArray()` The address as an array of bytes, with the highest byte first
`abstract byte[]`	`toBigEndianArray()` The address as an array of bytes, with the highest byte first
`java.math.BigInteger`	`toBigInteger()` The address as a BigInteger, unsigned
`java.net.InetAddress`	`toInetAddress()` The address as an InetAddress
`abstract byte[]`	`toLittleEndianArray()` The address as an array of bytes, with the highest byte last
`java.math.BigInteger`	`toSignedBigInteger()` The address as a BigInteger, signed
`abstract int`	`version()` Returns the version of the IP address

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

- Constructor Detail
  - IPAddress
```
public IPAddress()
```
- Method Detail
  - of
```
public static IPAddress of(byte[] bigEndianByteArr)
```
    Returns either an IPv4 or an IPv6 address
    
    Parameters:
    
    bigEndianByteArr - array of 4 or 16 bytes
    
    Returns:
    
    new IPv4Address / IPv6Address
    
    Throws:
    
    java.lang.IllegalArgumentException - if the given array isn't 4 or 16 bytes long
  - of
```
public static IPAddress of(java.lang.String ip)
```
    Returns either an IPv4 or an IPv6 address
    
    Parameters:
    
    ip - an IPv4 or IPv6 address in literal String form
    
    Returns:
    
    new IPv4Address / IPv6Address
    
    Throws:
    
    java.lang.IllegalArgumentException - if the given array isn't an IPv4/IPv6 address
  - of
```
public static IPAddress of(java.net.InetAddress address)
```
    Returns either an IPv4 or an IPv6 address built from an InetAddress
    
    Parameters:
    
    address - to copy from
    
    Returns:
    
    IPv4Address or IPv6Address instance
  - is6To4
```
public abstract boolean is6To4()
```
    Checks whether the given address is a 6to4 address
    
    Returns:
    
    true if the give address is a 6to4 address, false otherwise
  - isMartian
```
public abstract boolean isMartian()
```
    Martian addresses are reserved and private addresses that should not appear on the public internet
    
    Returns:
    
    true if the address is martian, false otherwise
  - isLoopback
```
public abstract boolean isLoopback()
```
    Checks whether the address is a loopback address
    
    Returns:
    
    true if the address is for a loopback, false otherwise
  - isMulticast
```
public abstract boolean isMulticast()
```
    Checks whether the address is part of a range reserved for multicast
    
    Returns:
    
    true if the address is reserved for multicast, false otherwise
  - isPrivate
```
public abstract boolean isPrivate()
```
    Checks whether the address is private
    
    Returns:
    
    true if the address is private, false otherwise
  - isReserved
```
public abstract boolean isReserved()
```
    Checks whether the address part of a reserved range
    
    Returns:
    
    true if the address is part of a reserved range, false otherwise
  - isUnspecified
```
public abstract boolean isUnspecified()
```
    Checks whether the address is "unspecified"
    
    Returns:
    
    true if the address is "unspecified", false otherwise
  - isLinkLocal
```
public abstract boolean isLinkLocal()
```
    Checks whether the address is link-local
    
    Returns:
    
    true if the address is link-local, false otherwise
  - version
```
public abstract int version()
```
    Returns the version of the IP address
    
    Returns:
    
    4 for IPv4, 6 for IPv6
  - next
```
public abstract IPAddress next()
```
    Returns the following address, with wraparound
    
    Returns:
    
    the address following this one
  - plus
```
public abstract IPAddress plus(int n)
```
    Return an address larger than the current one by n, with wraparound
    
    Parameters:
    
    n -
    
    Returns:
    
    an address larger by n
  - previous
```
public abstract IPAddress previous()
```
    Returns the previous address, with wraparound
    
    Returns:
    
    the address before this one
  - minus
```
public abstract IPAddress minus(int n)
```
    Return an address smaller than the current one by n, with wraparound
    
    Parameters:
    
    n -
    
    Returns:
    
    an address smaller by n
  - toBigEndianArray
```
public abstract byte[] toBigEndianArray()
```
    The address as an array of bytes, with the highest byte first
    
    Returns:
    
    big-endian byte array
  - toLittleEndianArray
```
public abstract byte[] toLittleEndianArray()
```
    The address as an array of bytes, with the highest byte last
    
    Returns:
    
    little-endian byte array
  - toArray
```
public byte[] toArray()
```
    The address as an array of bytes, with the highest byte first
    
    Returns:
    
    big-endian byte array
  - toBigInteger
```
public java.math.BigInteger toBigInteger()
```
    The address as a BigInteger, unsigned
    
    Returns:
    
    The address as an BigInteger
  - toSignedBigInteger
```
public java.math.BigInteger toSignedBigInteger()
```
    The address as a BigInteger, signed
    
    Returns:
    
    The address as an BigInteger
  - toInetAddress
```
public java.net.InetAddress toInetAddress()
```
    The address as an InetAddress
    
    Returns:
    
    The address as an InetAddress

Class IPAddress

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IPAddress

Method Detail

of

of

of

is6To4

isMartian

isLoopback

isMulticast

isPrivate

isReserved

isUnspecified

isLinkLocal

version

next

plus

previous

minus

toBigEndianArray

toLittleEndianArray

toArray

toBigInteger

toSignedBigInteger

toInetAddress