Package org.refcodes.component
Interface FlushHandle<H>
-
- Type Parameters:
H
- The type of the handle.
- All Known Subinterfaces:
CompositeComponentHandle<H,REF>
public interface FlushHandle<H>
TheFlushHandle
interface defines those methods related to the handle based flush operation.The handle reference requires the
Flushable
interface to be implemented.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
flush(H aHandle)
Flushes the component identified by the given handle.default void
flushUnchecked(H aHandle)
Flushes the component by callingflush(Object)
without you to require catching aOpenException
.boolean
hasFlush(H aHandle)
Determines whether the handle reference provides flushting by implementing theFlushable
interface.
-
-
-
Method Detail
-
hasFlush
boolean hasFlush(H aHandle) throws UnknownHandleRuntimeException
Determines whether the handle reference provides flushting by implementing theFlushable
interface.- Parameters:
aHandle
- The handle to test whether the reference provides the according functionality.- Returns:
- True in case the reference provides the according functionality.
- Throws:
UnknownHandleRuntimeException
- Thrown in case the handle is unknown (there is none reference for this handle).
-
flush
void flush(H aHandle) throws OpenException, UnknownHandleRuntimeException, UnsupportedHandleOperationRuntimeException
Flushes the component identified by the given handle.- Parameters:
aHandle
- The handle identifying the component.- Throws:
OpenException
- in case flushing fails.UnknownHandleRuntimeException
- Thrown in case the handle is unknown (there is none reference for this handle).UnsupportedHandleOperationRuntimeException
- in case the reference of the handle does not support the requested operation.IllegalHandleStateChangeRuntimeException
- Thrown in case a state change is not possible due to the current state the referenced component is in.
-
flushUnchecked
default void flushUnchecked(H aHandle)
Flushes the component by callingflush(Object)
without you to require catching aOpenException
.- Parameters:
aHandle
- The handle identifying the component.- Throws:
org.refcodes.exception.HiddenException
- encapsulates the cause and is thrown upon encountering aOpenException
exception
-
-