org.springframework.geode.core.env.support

Class CloudCacheService.Locator

java.lang.Object

org.springframework.geode.core.env.support.CloudCacheService.Locator

All Implemented Interfaces:

java.lang.Comparable<CloudCacheService.Locator>

Enclosing class:

CloudCacheService

public static class CloudCacheService.Locator
extends java.lang.Object
implements java.lang.Comparable<CloudCacheService.Locator>

Method Summary

Modifier and Type	Method and Description
int	compareTo(CloudCacheService.Locator other)
boolean	equals(java.lang.Object obj)
java.lang.String	getHost() Return the name of the host on which this CloudCacheService.Locator is running.
int	getPort() Returns the port on which this CloudCacheService.Locator is listening.
int	hashCode()
static CloudCacheService.Locator	newLocator() Factory method used to construct a new CloudCacheService.Locator on the default host and port.
static CloudCacheService.Locator	newLocator(int port) Factory method used to construct a new CloudCacheService.Locator running on the default host and configured to listen on the given port.
static CloudCacheService.Locator	newLocator(java.lang.String host) Factory method used to construct a new CloudCacheService.Locator configured to run on the given host and listening on the default port.
static CloudCacheService.Locator	newLocator(java.lang.String host, int port) Factory method used to construct a new CloudCacheService.Locator running on the configured host and listening on the configured port.
static CloudCacheService.Locator	parse(java.lang.String hostPort) Factory method used to parse an individual host[port] network endpoint for a Locator.
static java.util.List<CloudCacheService.Locator>	parseLocators(java.lang.String locators) Factory method used to parse a comma-delimited list of Locator network endpoints into a List of CloudCacheService.Locator objects.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newLocator

public static CloudCacheService.Locator newLocator()

Factory method used to construct a new CloudCacheService.Locator on the default host and port.

Returns:

a new, default CloudCacheService.Locator.

See Also:

newLocator(String, int)

newLocator

public static CloudCacheService.Locator newLocator(int port)

Factory method used to construct a new CloudCacheService.Locator running on the default host and configured to listen on the given port.

Parameters:

port - Integer containing the port number on which the CloudCacheService.Locator is listening.

Returns:

a new CloudCacheService.Locator running on the default host, listening on the given port.

Throws:

java.lang.IllegalArgumentException - if the port is less than 0.

See Also:

newLocator(String, int)

newLocator

public static CloudCacheService.Locator newLocator(java.lang.String host)

Factory method used to construct a new CloudCacheService.Locator configured to run on the given host and listening on the default port.

Parameters:

host - String containing the name of the host on which the CloudCacheService.Locator is running.

Returns:

a new CloudCacheService.Locator running on the configured host, listening on the default port.

Throws:

java.lang.IllegalArgumentException - if host is null or empty.

See Also:

newLocator(String, int)

newLocator

public static CloudCacheService.Locator newLocator(java.lang.String host,
                                                   int port)

Factory method used to construct a new CloudCacheService.Locator running on the configured host and listening on the configured port.

Parameters:

host - String containing the name of the host on which the CloudCacheService.Locator is running.

port - Integer containing the port number on which the CloudCacheService.Locator is listening.

Returns:

a new CloudCacheService.Locator on the configured host and port.

Throws:

java.lang.IllegalArgumentException - if host is null or empty, or the port is less than 0.

parseLocators

public static java.util.List<CloudCacheService.Locator> parseLocators(java.lang.String locators)

Factory method used to parse a comma-delimited list of Locator network endpoints into a List of CloudCacheService.Locator objects. The comma-delimited list of Locators must be formatted as host1[port1],host2[port2], ...,hostN[portN].

Parameters:

locators - String containing a comma-delimited list of Locator network endpoints.

Returns:

a new List of CloudCacheService.Locator objects or an empty List if no Locators were specified.

Throws:

java.lang.IllegalArgumentException - if an individual Locator host[port] is not valid.

See Also:

parse(String)

parse

public static CloudCacheService.Locator parse(java.lang.String hostPort)

Factory method used to parse an individual host[port] network endpoint for a Locator.

Parameters:

hostPort - String containing the Locator host and port to parse.

Returns:

a new CloudCacheService.Locator configured from the given String.

Throws:

java.lang.IllegalArgumentException - if the hostPort are not valid.

See Also:

parseHost(String), parsePort(String), newLocator(String, int)

getHost

public java.lang.String getHost()

Return the name of the host on which this CloudCacheService.Locator is running. Defaults to localhost.

Returns:

the name of the host on which this CloudCacheService.Locator is running.

getPort

public int getPort()

Returns the port on which this CloudCacheService.Locator is listening. Defaults to 10334.

Returns:

the port on which this CloudCacheService.Locator is listening.

compareTo

public int compareTo(CloudCacheService.Locator other)

Specified by:

compareTo in interface java.lang.Comparable<CloudCacheService.Locator>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object