appilog.common.utils

Class Range

java.lang.Object

appilog.common.utils.Range

public class Range
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CIDR_DELIMITER
static java.lang.String	INVALID_RANGE_FORMAT
static java.lang.String	INVALID_RANGE_SPECIFIED
static java.lang.String	RANGE_DELIMITER
static java.lang.String	SUPPLIED_RANGE_IS_NULL

Constructor Summary

Constructors

Constructor and Description
Range(IPv4 ipMasked)
Range(IPv4 startIp, IPv4 lastIp)
Range(IPv4 startIp, IPv4 lastIp, RangeDefinitionType rangeDefinitionType)
Range(IPv4 startIp, IPv4 lastIp, RangeType type)
Range(IPv4 startIp, IPv4 lastIp, RangeType type, RangeDefinitionType rangeDefinitionType)
Range(IPv4 ipMasked, RangeDefinitionType rangeDefinitionType)
Range(java.lang.String range)
Range(java.lang.String range, RangeDefinitionType rangeDefinitionType) Range must be in the format of IP(low)-IP(high) or CIDR-notation string, e.g.
Range(java.lang.String range, RangeType type) Range must be in the format of IP(low)-IP(high) or CIDR notation
Range(java.lang.String range, RangeType type, RangeDefinitionType rangeDefinitionType) Range must be in the format of IP(low)-IP(high) or CIDR notation

Method Summary

Methods

Modifier and Type	Method and Description
Range	createNewRangeWithSameAttributes(IPv4 startIp, IPv4 lastIp)
Range[]	createRangeArray(int size)
boolean	equals(java.lang.Object o)
java.util.List<java.lang.String>	getAllIPs(int maxIPs) Get list of IPs in range.
RangeDefinitionType	getDefinitionType()
IPv4	getFirstIp()
IPv4	getLastIp()
Range	getOverlapRange(Range r)
RangeType	getRawType() Gets the raw type of the ip range.
long	getTotalIPs() Get total IPs is range
RangeType	getType() Gets the type of the ip range.
int	hashCode()
void	initRange(IPv4 firstIp, IPv4 lastIp)
boolean	isEmptyRange()
boolean	isIpInRange(IPv4 ip)
boolean	isRangeOverlap(Range r)
boolean	isRangeValid() Valid range definition: 1.
boolean	isSubRangeOf(Range r)
void	setDefinitionType(RangeDefinitionType definitionType)
void	setType(RangeType type)
Range[]	splitRangeByExcludeRanges(Range[] excludeRanges) Splits range with excluded ranges
static int[]	splitRanges(int[] src)
java.lang.String	toRangeString()
java.lang.String	toRangeString(java.lang.String separator)
java.lang.String	toString()
java.lang.String	toStringByDefinition()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

INVALID_RANGE_SPECIFIED

public static java.lang.String INVALID_RANGE_SPECIFIED

INVALID_RANGE_FORMAT

public static java.lang.String INVALID_RANGE_FORMAT

SUPPLIED_RANGE_IS_NULL

public static java.lang.String SUPPLIED_RANGE_IS_NULL

CIDR_DELIMITER

public static final java.lang.String CIDR_DELIMITER

See Also:

Constant Field Values

RANGE_DELIMITER

public static final java.lang.String RANGE_DELIMITER

See Also:

Constant Field Values

Constructor Detail

Range

public Range(IPv4 startIp,
     IPv4 lastIp,
     RangeDefinitionType rangeDefinitionType)

Range

public Range(IPv4 startIp,
     IPv4 lastIp)

Range

public Range(IPv4 startIp,
     IPv4 lastIp,
     RangeType type,
     RangeDefinitionType rangeDefinitionType)

Range

public Range(IPv4 startIp,
     IPv4 lastIp,
     RangeType type)

Range

public Range(IPv4 ipMasked,
     RangeDefinitionType rangeDefinitionType)

Range

public Range(IPv4 ipMasked)

Range

public Range(java.lang.String range)

Range

public Range(java.lang.String range,
     RangeDefinitionType rangeDefinitionType)

Range must be in the format of IP(low)-IP(high) or CIDR-notation string, e.g. "192.168.0.1/16, in case the rangeDefinitionType is null -> type decided by range string

Parameters:

range - range string representation

Range

public Range(java.lang.String range,
     RangeType type)

Range must be in the format of IP(low)-IP(high) or CIDR notation

Parameters:

range - range string representation

type - the type of the ip range

Range

public Range(java.lang.String range,
     RangeType type,
     RangeDefinitionType rangeDefinitionType)

Range must be in the format of IP(low)-IP(high) or CIDR notation

Parameters:

range - range string representation

type - the type of the ip range

Method Detail

initRange

public void initRange(IPv4 firstIp,
             IPv4 lastIp)

toRangeString

public java.lang.String toRangeString()

toRangeString

public java.lang.String toRangeString(java.lang.String separator)

toStringByDefinition

public java.lang.String toStringByDefinition()

getFirstIp

public IPv4 getFirstIp()

getLastIp

public IPv4 getLastIp()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isIpInRange

public boolean isIpInRange(IPv4 ip)

isRangeOverlap

public boolean isRangeOverlap(Range r)

isSubRangeOf

public boolean isSubRangeOf(Range r)

splitRangeByExcludeRanges

public Range[] splitRangeByExcludeRanges(Range[] excludeRanges)

Splits range with excluded ranges

Parameters:

excludeRanges - excluded ranges

Returns:

array of ranges divided by given exclude ranges

createNewRangeWithSameAttributes

public Range createNewRangeWithSameAttributes(IPv4 startIp,
                                     IPv4 lastIp)

createRangeArray

public Range[] createRangeArray(int size)

getOverlapRange

public Range getOverlapRange(Range r)

isRangeValid

public boolean isRangeValid()

Valid range definition: 1. End IP != null and either start or end ip are not single IP

Returns:

true if range is valid

isEmptyRange

public boolean isEmptyRange()

splitRanges

public static int[] splitRanges(int[] src)

getTotalIPs

public long getTotalIPs()

Get total IPs is range

Returns:

number of IP Addresses in range

getAllIPs

public java.util.List<java.lang.String> getAllIPs(int maxIPs)
                                           throws java.lang.Exception

Get list of IPs in range. if number of IP in range is greater then max allowed (maxIPs) and Exception is thrown

Parameters:

maxIPs - - max allowed IP addresses in range, to fetch

Returns:

Throws:

java.lang.Exception

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getType

public RangeType getType()

Gets the type of the ip range. Considered as a Data Center as default.

Returns:

the ip range type. Returns RangeType.DATA_CENTER if the type is not defined.

getRawType

public RangeType getRawType()

Gets the raw type of the ip range. No default value provided.

setType

public void setType(RangeType type)

getDefinitionType

public RangeDefinitionType getDefinitionType()

setDefinitionType

public void setDefinitionType(RangeDefinitionType definitionType)