net.grinder.tools.tcpproxy

Class EndPoint

java.lang.Object

net.grinder.tools.tcpproxy.EndPoint

All Implemented Interfaces:

Comparable<EndPoint>

public final class EndPoint
extends Object
implements Comparable<EndPoint>

Class that represents the endpoint of a TCP connection. One day, when we can depend on JDK 1.4, this may be replaced by java.net.InetSocketAddress.

Author:

Philip Aston

Constructor Summary

Constructors

Constructor and Description
EndPoint(InetAddress address, int port) Constructor.
EndPoint(String host, int port) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static EndPoint	clientEndPoint(Socket socket) Return an EndPoint describing the remote (client) side of the given socket.
int	compareTo(EndPoint otherEndPoint) Implement Comparable so that we can order pairs of EndPoint's consistently.
boolean	equals(Object other) Value based equality.
String	getHost() Accessor.
int	getPort() Accessor.
int	hashCode() Implement Object.hashCode().
static EndPoint	serverEndPoint(ServerSocket socket) Return an EndPoint describing the local (server) side of the given server socket.
String	toString() String representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndPoint

public EndPoint(String host,
        int port)

Constructor.

Parameters:

host - Host name or IP address.

port - Port.

EndPoint

public EndPoint(InetAddress address,
        int port)

Constructor.

In a perfect world, EndPoint would use InetAddress in its internal representation.

Parameters:

address - Address.

port - Port

Method Detail

getHost

public String getHost()

Accessor.

Returns:

Host name or IP address.

getPort

public int getPort()

Accessor.

Returns:

an int value

equals

public boolean equals(Object other)

Value based equality.

Overrides:

equals in class Object

Parameters:

other - an Object value

Returns:

true => other is equal to this object.

hashCode

public int hashCode()

Implement Object.hashCode().

Overrides:

hashCode in class Object

Returns:

The hash code.

toString

public String toString()

String representation.

Overrides:

toString in class Object

Returns:

The string.

compareTo

public int compareTo(EndPoint otherEndPoint)

Implement Comparable so that we can order pairs of EndPoint's consistently.

Specified by:

compareTo in interface Comparable<EndPoint>

Parameters:

otherEndPoint - Object to be compared.

Returns:

A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

clientEndPoint

public static EndPoint clientEndPoint(Socket socket)

Return an EndPoint describing the remote (client) side of the given socket.

Parameters:

socket - The socket.

Returns:

The end point.

serverEndPoint

public static EndPoint serverEndPoint(ServerSocket socket)

Return an EndPoint describing the local (server) side of the given server socket.

Parameters:

socket - The server socket.

Returns:

The end point.