org.terracotta.utilities.test.net

Class PortManager.PortRef

java.lang.Object

org.terracotta.utilities.test.net.PortManager.PortRef

All Implemented Interfaces:

java.lang.AutoCloseable

Enclosing class:

PortManager

public static class PortManager.PortRef
extends java.lang.Object
implements java.lang.AutoCloseable

Represents a reserved TCP port. When use of the port is no longer needed, this reference should be closed to release the reservation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PortManager.PortRef.CloseOption Options that may be used with close(Set).

Method Summary

Modifier and Type	Method and Description
void	close() Closes this PortRef.
void	close(java.util.Set<PortManager.PortRef.CloseOption> options) Closes this PortRef using the options provided.
boolean	isClosed() Returns whether or not this PortRef is closed.
int	port() Gets the reserved port number.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

port

public int port()

Gets the reserved port number.

Returns:

the port number

isClosed

public boolean isClosed()

Returns whether or not this PortRef is closed.

Returns:

true if this PortRef has been closed; false otherwise

close

public void close()

Closes this PortRef.

Specified by:

close in interface java.lang.AutoCloseable

close

public void close(java.util.Set<PortManager.PortRef.CloseOption> options)

Closes this PortRef using the options provided.

Parameters:

options - the set of PortManager.PortRef.CloseOptions to apply to this close call; may be empty but not null