Module com.aoapps.net.types

Package com.aoapps.net

Class PortRange

java.lang.Object

com.aoapps.net.IPortRange

com.aoapps.net.PortRange

All Implemented Interfaces:

DtoFactory<PortRange>, Serializable, Comparable<IPortRange>

public final class PortRange
extends IPortRange
implements Serializable, DtoFactory<PortRange>

A port range and associated protocol. The range must represent at least two ports.

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.aoapps.net.IPortRange

MAX_PORT, MIN_PORT

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Unlike Port, port ranges are not cached and may not be safely compared by identity.
PortRange	getDto()
int	getFrom()	Gets the first port number in the range.
Port	getFromPort()	Gets the first port number in the range as a Port.
int	getTo()	Gets the last port number in the range.
Port	getToPort()	Gets the last port number in the range as a Port.
int	hashCode()
IPortRange	splitAbove(int above)
IPortRange	splitBelow(int below)
String	toString()
static ValidationResult	validate(int from, int to, Protocol protocol)
static PortRange	valueOf(int from, int to, Protocol protocol)

Methods inherited from class com.aoapps.net.IPortRange

coalesce, compareTo, getProtocol, overlaps

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

validate

public static ValidationResult validate(int from,
 int to,
 Protocol protocol)

valueOf

public static PortRange valueOf(int from,
 int to,
 Protocol protocol)
                         throws ValidationException

Throws:

ValidationException

equals

public boolean equals(Object obj)

Unlike Port, port ranges are not cached and may not be safely compared by identity.

Specified by:

equals in class IPortRange

hashCode

public int hashCode()

Specified by:

hashCode in class IPortRange

toString

public String toString()

Specified by:

toString in class IPortRange

Returns:

The port range and protocol, such as 53/UDP or 8080-8087/TCP.

See Also:

• Port.toString()
• toString()

getFrom

public int getFrom()

Description copied from class: IPortRange

Gets the first port number in the range.

Specified by:

getFrom in class IPortRange

getFromPort

public Port getFromPort()

Description copied from class: IPortRange

Gets the first port number in the range as a Port.

Specified by:

getFromPort in class IPortRange

getTo

public int getTo()

Description copied from class: IPortRange

Gets the last port number in the range.

Specified by:

getTo in class IPortRange

getToPort

public Port getToPort()

Description copied from class: IPortRange

Gets the last port number in the range as a Port.

Specified by:

getToPort in class IPortRange

getDto

public PortRange getDto()

Specified by:

getDto in interface DtoFactory<PortRange>

splitBelow

public IPortRange splitBelow(int below)

Specified by:

splitBelow in class IPortRange

Returns:

The part of this port range below, and not including, the given port or null if none.

splitAbove

public IPortRange splitAbove(int above)

Specified by:

splitAbove in class IPortRange

Returns:

The part of this port range above, and not including, the given port or null if none.