|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
java.util.AbstractCollection
com.tangosol.net.CompositeAddressProvider
public class CompositeAddressProvider
CompositeAddressProvider is a composite of one or more AddressProviders or addresses that also implements the Set interface. This AddressProvider will provide addresses from all registered AddressProviders or Addresses. <p/> This class implements the Set interface, but the contents are not checked to determine whether each element is unique. It is the responsibility of the user to ensure that the elements are unique if the object is used as a Set. <p/> This implementation is thread-safe for consumers of the Set interface, but allows no more than one consumer of the AddressProvider interface.
Nested Class Summary | |
---|---|
protected static class |
CompositeAddressProvider.AddressIterator An Iterator over the addresses in this AddressProvider. |
protected class |
CompositeAddressProvider.SingleProvider AddressProvider wrapper for a single address dynamically added to this AddressSet. |
Field Summary | |
---|---|
protected CompositeAddressProvider.AddressIterator |
m_iterInternal The default iterator used to implement the AddressProvider interface. |
Constructor Summary | |
---|---|
CompositeAddressProvider() Default constructor. |
Method Summary | |
---|---|
void |
accept() This method should be called by the client immediately after it determines that it can successfully use an address returned by the AddressProvider.getNextAddress() method. |
boolean |
add(Object o) Ensures that this collection contains the specified element (optional operation). |
void |
addAddress(InetSocketAddress address) Add an address. |
void |
addProvider(AddressProvider provider) Add an AddressProvider. |
protected CompositeAddressProvider.AddressIterator |
ensureInternalIterator() Create (if necessary) and return the default iterator. |
boolean |
equals(Object o) AddressProvider instances are considered equivalent iff they consistently produce the same resulting set of addresses. |
InetSocketAddress |
getNextAddress() Obtain a next available address to use. |
protected List |
getProviderList() Return the provider list. |
int |
hashCode() Return the hash code for this AddressProvider. |
Iterator |
iterator() Returns an iterator over the elements contained in this collection. |
void |
reject(Throwable eCause) This method should be called by the client immediately after it determines that an attempt to use an address returned by the AddressProvider.getNextAddress() method has failed. |
boolean |
remove(Object o) Removes the specified element from this set if it is present (optional operation). |
int |
size() Returns the number of elements in this collection. |
Methods inherited from class java.util.AbstractCollection |
---|
addAll, clear, contains, containsAll, isEmpty, removeAll, retainAll, toArray, toArray, toString |
Methods inherited from interface java.util.Set |
---|
addAll, clear, contains, containsAll, isEmpty, removeAll, retainAll, toArray, toArray |
Field Detail |
---|
protected CompositeAddressProvider.AddressIterator m_iterInternal
Constructor Detail |
---|
public CompositeAddressProvider()
Method Detail |
---|
public void addProvider(AddressProvider provider)
provider
- the AddressProvider to addpublic void addAddress(InetSocketAddress address)
address
- the address to addprotected List getProviderList()
public InetSocketAddress getNextAddress()
AddressProvider.accept()
method.getNextAddress
in interface AddressProvider
public void accept()
AddressProvider.getNextAddress()
method.accept
in interface AddressProvider
public void reject(Throwable eCause)
AddressProvider.getNextAddress()
method has failed.reject
in interface AddressProvider
eCause
- (optional) an exception that carries the reason why the the caller rejected the previously returned addresspublic boolean equals(Object o)
equals
in interface AddressProvider
equals
in interface Collection
equals
in interface Set
public int hashCode()
hashCode
in interface AddressProvider
hashCode
in interface Collection
hashCode
in interface Set
public Iterator iterator()
iterator
in interface Iterable
iterator
in interface Collection
iterator
in interface Set
iterator
in class AbstractCollection
public int size()
size
in interface Collection
size
in interface Set
size
in class AbstractCollection
public boolean add(Object o)
This implementation always throws an UnsupportedOperationException.
add
in interface Collection
add
in interface Set
add
in class AbstractCollection
o
- element whose presence in this collection is to be ensured.UnsupportedOperationException
- if the add method is not supported by this collection.NullPointerException
- if this collection does not permit null elements, and the specified element is null.ClassCastException
- if the class of the specified element prevents it from being added to this collection.IllegalArgumentException
- if some aspect of this element prevents it from being added to this collection.public boolean remove(Object o)
e
such that (o==null ? e==null : o.equals(e))
, if the set contains such an element. Returns true if the set contained the specified element (or equivalently, if the set changed as a result of the call). (The set will not contain the specified element once the call returns.)remove
in interface Collection
remove
in interface Set
remove
in class AbstractCollection
o
- object to be removed from this set, if present.ClassCastException
- if the type of the specified element is incompatible with this set (optional).NullPointerException
- if the specified element is null and this set does not support null elements (optional).UnsupportedOperationException
- if the remove method is not supported by this set.protected CompositeAddressProvider.AddressIterator ensureInternalIterator()
|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |