org.springframework.data.gemfire.support

Class ConnectionEndpointList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<ConnectionEndpoint>

org.springframework.data.gemfire.support.ConnectionEndpointList

All Implemented Interfaces:

Iterable<ConnectionEndpoint>, Collection<ConnectionEndpoint>, List<ConnectionEndpoint>

public class ConnectionEndpointList
extends AbstractList<ConnectionEndpoint>

The ConnectionEndpointList class is an Iterable collection of ConnectionEndpoint objects.

Since:

1.6.3

Author:

John Blum

See Also:

Iterable, InetSocketAddress, AbstractList, List, ConnectionEndpoint

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ConnectionEndpointList() Constructs a new, empty and uninitialized instance of the ConnectionEndpointList.
ConnectionEndpointList(ConnectionEndpoint... connectionEndpoints) Constructs a new instance of ConnectionEndpointList initialized with an array of ConnectionEndpoints.
ConnectionEndpointList(Iterable<ConnectionEndpoint> connectionEndpoints) Constructs a new instance of ConnectionEndpointList initialized with the Iterable collection of ConnectionEndpoints.

Method Summary

Modifier and Type	Method and Description
ConnectionEndpointList	add(ConnectionEndpoint... connectionEndpoints) Adds the array of ConnectionEndpoints to this list.
boolean	add(ConnectionEndpoint connectionEndpoint) Adds the given ConnectionEndpoint to this list.
ConnectionEndpointList	add(Iterable<ConnectionEndpoint> connectionEndpoints) Adds the Iterable collection of ConnectionEndpoints to this list.
void	clear() Clears the current list of ConnectionEndpoints.
ConnectionEndpointList	findBy(int port) Finds all ConnectionEndpoints in this list with the specified port number.
ConnectionEndpointList	findBy(String host) Finds all ConnectionEndpoints in this list with the specified hostname.
ConnectionEndpoint	findOne(int port) Finds the first ConnectionEndpoint in the collection with the given port.
ConnectionEndpoint	findOne(String host) Finds the first ConnectionEndpoint in the collection with the given host.
static ConnectionEndpointList	from(ConnectionEndpoint... connectionEndpoints) Factory method used to create a ConnectionEndpointList from an array of ConnectionPoints.
static ConnectionEndpointList	from(InetSocketAddress... socketAddresses) Factory method used to create a ConnectionEndpointList from an array of InetSocketAddresses.
static ConnectionEndpointList	from(Iterable<InetSocketAddress> socketAddresses) Factory method used to create a ConnectionEndpointList from an Iterable of InetSocketAddresses.
ConnectionEndpoint	get(int index) Gets the ConnectionEndpoint at the given index in this list.
boolean	isEmpty() Determines whether this collection contains any ConnectionEndpoints.
Iterator<ConnectionEndpoint>	iterator()
static ConnectionEndpointList	parse(int defaultPort, String... hostsPorts) Parses the array of hosts and ports in the format host[port] or host:port to convert into an instance of ConnectionEndpointList.
static ConnectionEndpointList	parse(String commaDelimitedHostAndPorts, int defaultPort) Parses the comma-delimited hosts and ports in the format host[port] or host:port to convert into an instance of ConnectionEndpointList.
ConnectionEndpoint	set(int index, ConnectionEndpoint element) Sets the element at the given index in this list to the given ConnectionEndpoint.
int	size() Determines the number of ConnectionEndpoints contained in this collection.
ConnectionEndpoint[]	toArray() Converts this collection of ConnectionEndpoints into an array of ConnectionEndpoints.
List<InetSocketAddress>	toInetSocketAddresses() Converts this collection of ConnectionEndpoints into a List of InetSocketAddresses.
String	toString()

Methods inherited from class java.util.AbstractList

add, addAll, equals, hashCode, indexOf, lastIndexOf, listIterator, listIterator, remove, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, remove, removeAll, retainAll, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

addAll, contains, containsAll, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ConnectionEndpointList

public ConnectionEndpointList()

Constructs a new, empty and uninitialized instance of the ConnectionEndpointList.

See Also:

ConnectionEndpointList(Iterable)

ConnectionEndpointList

public ConnectionEndpointList(@NonNull
                              ConnectionEndpoint... connectionEndpoints)

Constructs a new instance of ConnectionEndpointList initialized with an array of ConnectionEndpoints.

Parameters:

connectionEndpoints - array of ConnectionEndpoints to add to this list.

See Also:

ConnectionEndpoint, ConnectionEndpointList(Iterable)

ConnectionEndpointList

public ConnectionEndpointList(@NonNull
                              Iterable<ConnectionEndpoint> connectionEndpoints)

Constructs a new instance of ConnectionEndpointList initialized with the Iterable collection of ConnectionEndpoints.

Parameters:

connectionEndpoints - Iterable object containing ConnectionEndpoints to add to this list.

See Also:

ConnectionEndpoint, Iterable, add(Iterable)

Method Detail

from

public static ConnectionEndpointList from(ConnectionEndpoint... connectionEndpoints)

Factory method used to create a ConnectionEndpointList from an array of ConnectionPoints.

Parameters:

connectionEndpoints - array of ConnectionPoints used to initialize a new instance of ConnectionEndpointList.

Returns:

a ConnectionEndpointList initialized with the array of ConnectionPoints.

See Also:

ConnectionEndpoint

from

public static ConnectionEndpointList from(InetSocketAddress... socketAddresses)

Factory method used to create a ConnectionEndpointList from an array of InetSocketAddresses.

Parameters:

socketAddresses - array of InetSocketAddresses used to initialize a new instance of ConnectionEndpointList.

Returns:

a ConnectionEndpointList initialized from the array of InetSocketAddresses.

See Also:

InetSocketAddress, from(Iterable)

from

public static ConnectionEndpointList from(Iterable<InetSocketAddress> socketAddresses)

Factory method used to create a ConnectionEndpointList from an Iterable of InetSocketAddresses.

Parameters:

socketAddresses - Iterable of InetSocketAddresses used to initialize a new instance of ConnectionEndpointList.

Returns:

a ConnectionEndpointList initialized from an Iterable of InetSocketAddresses.

See Also:

InetSocketAddress, Iterable

parse

public static ConnectionEndpointList parse(String commaDelimitedHostAndPorts,
                                           int defaultPort)

Parses the comma-delimited hosts and ports in the format host[port] or host:port to convert into an instance of ConnectionEndpointList.

Parameters:

commaDelimitedHostAndPorts - String containing a comma-delimited String of hosts and ports.

defaultPort - default port number to use if port is not specified in a host and port value.

Returns:

a new ConnectionEndpointList representing the hosts and ports.

See Also:

parse(int, String...)

parse

public static ConnectionEndpointList parse(int defaultPort,
                                           String... hostsPorts)

Parses the array of hosts and ports in the format host[port] or host:port to convert into an instance of ConnectionEndpointList.

Parameters:

defaultPort - default port number to use if port is not specified in a host and port value.

hostsPorts - array of hosts and ports to parse.

Returns:

a new ConnectionEndpointList representing the hosts and ports in the array.

See Also:

ConnectionEndpoint.parse(String, int), ConnectionEndpointList(Iterable)

add

public boolean add(ConnectionEndpoint connectionEndpoint)

Adds the given ConnectionEndpoint to this list.

Specified by:

add in interface Collection<ConnectionEndpoint>

Specified by:

add in interface List<ConnectionEndpoint>

Overrides:

add in class AbstractList<ConnectionEndpoint>

Parameters:

connectionEndpoint - ConnectionEndpoint to add to this list.

Returns:

a boolean value indicating whether this list was modified by the add operation.

See Also:

ConnectionEndpoint, add(ConnectionEndpoint...)

add

public final ConnectionEndpointList add(ConnectionEndpoint... connectionEndpoints)

Adds the array of ConnectionEndpoints to this list.

Parameters:

connectionEndpoints - array of ConnectionEndpoints to add to this list.

Returns:

this ConnectionEndpointList.

See Also:

ConnectionEndpoint, add(Iterable)

add

public final ConnectionEndpointList add(Iterable<ConnectionEndpoint> connectionEndpoints)

Adds the Iterable collection of ConnectionEndpoints to this list.

Parameters:

connectionEndpoints - Iterable collection of ConnectionEndpoints to add to this list.

Returns:

this ConnectionEndpointList.

See Also:

ConnectionEndpoint, add(ConnectionEndpoint...)

clear

public void clear()

Clears the current list of ConnectionEndpoints.

Specified by:

clear in interface Collection<ConnectionEndpoint>

Specified by:

clear in interface List<ConnectionEndpoint>

Overrides:

clear in class AbstractList<ConnectionEndpoint>

findBy

@NonNull
public ConnectionEndpointList findBy(String host)

Finds all ConnectionEndpoints in this list with the specified hostname.

Parameters:

host - String indicating the hostname to use in the match.

Returns:

a ConnectionEndpointList (sub-List) containing all the ConnectionEndpoints matching the given hostname.

See Also:

findBy(int)

findBy

@NonNull
public ConnectionEndpointList findBy(int port)

Finds all ConnectionEndpoints in this list with the specified port number.

Parameters:

port - Integer value indicating the port number to use in the match.

Returns:

a ConnectionEndpointList (sub-List) containing all the ConnectionEndpoints matching the given port number.

See Also:

findBy(String)

findOne

@Nullable
public ConnectionEndpoint findOne(String host)

Finds the first ConnectionEndpoint in the collection with the given host.

Parameters:

host - a String indicating the hostname of the ConnectionEndpoint to find.

Returns:

the first ConnectionEndpoint in this collection with the given host, or null if no ConnectionEndpoint exists with the given hostname.

See Also:

findBy(String)

findOne

@Nullable
public ConnectionEndpoint findOne(int port)

Finds the first ConnectionEndpoint in the collection with the given port.

Parameters:

port - an integer indicating the port number of the ConnectionEndpoint to find.

Returns:

the first ConnectionEndpoint in this collection with the given port, or null if no ConnectionEndpoint exists with the given port number.

See Also:

findBy(int)

get

public ConnectionEndpoint get(int index)

Gets the ConnectionEndpoint at the given index in this list.

Specified by:

get in interface List<ConnectionEndpoint>

Specified by:

get in class AbstractList<ConnectionEndpoint>

Parameters:

index - an integer value indicating the index of the ConnectionEndpoint of interest.

Returns:

the ConnectionEndpoint at index in this list.

Throws:

IndexOutOfBoundsException - if the index is not within the bounds of this list.

See Also:

ConnectionEndpoint, AbstractList.get(int)

set

public ConnectionEndpoint set(int index,
                              ConnectionEndpoint element)

Sets the element at the given index in this list to the given ConnectionEndpoint.

Specified by:

set in interface List<ConnectionEndpoint>

Overrides:

set in class AbstractList<ConnectionEndpoint>

Parameters:

index - the index in the list at which to set the ConnectionEndpoint.

element - the ConnectionEndpoint to set in this list at the given index.

Returns:

the old ConnectionEndpoint at index in this list or null if no ConnectionEndpoint at index existed.

Throws:

IndexOutOfBoundsException - if the index is not within the bounds of this list.

See Also:

ConnectionEndpoint, AbstractList.set(int, Object)

isEmpty

public boolean isEmpty()

Determines whether this collection contains any ConnectionEndpoints.

Specified by:

isEmpty in interface Collection<ConnectionEndpoint>

Specified by:

isEmpty in interface List<ConnectionEndpoint>

Overrides:

isEmpty in class AbstractCollection<ConnectionEndpoint>

Returns:

a boolean value indicating whether this collection contains any ConnectionEndpoints.

iterator

@NonNull
public Iterator<ConnectionEndpoint> iterator()

Specified by:

iterator in interface Iterable<ConnectionEndpoint>

Specified by:

iterator in interface Collection<ConnectionEndpoint>

Specified by:

iterator in interface List<ConnectionEndpoint>

Overrides:

iterator in class AbstractList<ConnectionEndpoint>

size

public int size()

Determines the number of ConnectionEndpoints contained in this collection.

Specified by:

size in interface Collection<ConnectionEndpoint>

Specified by:

size in interface List<ConnectionEndpoint>

Specified by:

size in class AbstractCollection<ConnectionEndpoint>

Returns:

an integer value indicating the number of ConnectionEndpoints contained in this collection.

toArray

public ConnectionEndpoint[] toArray()

Converts this collection of ConnectionEndpoints into an array of ConnectionEndpoints.

Specified by:

toArray in interface Collection<ConnectionEndpoint>

Specified by:

toArray in interface List<ConnectionEndpoint>

Overrides:

toArray in class AbstractCollection<ConnectionEndpoint>

Returns:

an array of ConnectionEndpoints representing this collection.

toInetSocketAddresses

public List<InetSocketAddress> toInetSocketAddresses()

Converts this collection of ConnectionEndpoints into a List of InetSocketAddresses.

Returns:

a List of InetSocketAddresses representing this collection of ConnectionEndpoints.

See Also:

ConnectionEndpoint.toInetSocketAddress(), InetSocketAddress, List

toString

public String toString()

Overrides:

toString in class AbstractCollection<ConnectionEndpoint>