public class ObservableSync extends java.lang.Object implements Sync
Because ObservableSync does not itself perform any synchronization control, the attempt operation always succeeds. This class is typically used (via LayeredSync) as a wrapper around those that do perform synchronization control.
This class is based around a standard Observer design pattern. It is not hard to convert this to instead use a Listener design (as seen in AWT and JavaBeans), by defining associated EventObjects and forwarding them.
LayeredSync
Modifier and Type | Class and Description |
---|---|
static interface |
ObservableSync.SyncObserver
Interface for objects that observe ObservableSyncs.
|
Modifier and Type | Field and Description |
---|---|
protected java.lang.Object |
arg_ |
protected CopyOnWriteArraySet |
observers_ |
ONE_CENTURY, ONE_DAY, ONE_HOUR, ONE_MINUTE, ONE_SECOND, ONE_WEEK, ONE_YEAR
Constructor and Description |
---|
ObservableSync(java.lang.Object notificationArgument)
Create an ObservableSync that uses the supplied argument
for all notifications.
|
Modifier and Type | Method and Description |
---|---|
void |
acquire()
Wait (possibly forever) until successful passage.
|
void |
attach(ObservableSync.SyncObserver obs)
Add obs to the set of observers
|
boolean |
attempt(long msecs)
Wait at most msecs to pass; report whether passed.
|
void |
detach(ObservableSync.SyncObserver obs)
Remove obs from the set of observers.
|
java.lang.Object |
getNotificationArgument()
Return the argument used for notifications
|
java.util.Iterator |
observers()
Return an iterator that can be used to traverse through
current set of observers
|
void |
release()
Potentially enable others to pass.
|
java.lang.Object |
setNotificationArgument(java.lang.Object notificationArg)
Set the argument used for notifications.
|
protected final CopyOnWriteArraySet observers_
protected java.lang.Object arg_
public ObservableSync(java.lang.Object notificationArgument)
public java.lang.Object getNotificationArgument()
public java.lang.Object setNotificationArgument(java.lang.Object notificationArg)
public void acquire()
Sync
public boolean attempt(long msecs)
Sync
The method has best-effort semantics: The msecs bound cannot be guaranteed to be a precise upper bound on wait time in Java. Implementations generally can only attempt to return as soon as possible after the specified bound. Also, timers in Java do not stop during garbage collection, so timeouts can occur just because a GC intervened. So, msecs arguments should be used in a coarse-grained manner. Further, implementations cannot always guarantee that this method will return at all without blocking indefinitely when used in unintended ways. For example, deadlocks may be encountered when called in an unintended context.
attempt
in interface Sync
msecs
- the number of milleseconds to wait.
An argument less than or equal to zero means not to wait at all.
However, this may still require
access to a synchronization lock, which can impose unbounded
delay if there is a lot of contention among threads.public void release()
Sync
Because release does not raise exceptions, it can be used in `finally' clauses without requiring extra embedded try/catch blocks. But keep in mind that as with any java method, implementations may still throw unchecked exceptions such as Error or NullPointerException when faced with uncontinuable errors. However, these should normally only be caught by higher-level error handlers.
public void attach(ObservableSync.SyncObserver obs)
public void detach(ObservableSync.SyncObserver obs)
public java.util.Iterator observers()