Module org.refcodes.component
Package org.refcodes.component

Interface OpenableHandle<H>

Type Parameters:
H - The type of the handle.
All Known Subinterfaces:
LinkComponentHandle<H>, LinkComponentHandle.LinkAutomatonHandle<H>, OpenableHandle.OpenAutomatonHandle<H>
public interface OpenableHandle<H>
The OpenableHandle interface defines those methods related to the handle based open/connect life-cycle.

The handle reference requires the Openable interface to be implemented.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    OpenableHandle.OpenAutomatonHandle<H>
    The OpenableHandle.OpenAutomatonHandle interface defines those methods related to the handle based open/connect life-cycle.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    hasOpenable(H aHandle)
    Determines whether the handle reference is openable by implementing the Openable interface.
    void
    open(H aHandle)
    Open/connect the component identified by the given handle.
    default void
    openUnchecked(H aHandle)
    Opens the component by calling open(Object) without you to require catching an IOException.

  • Method Details

    • hasOpenable

      boolean hasOpenable(H aHandle)
      Determines whether the handle reference is openable by implementing the Openable 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 - in case the handle is unknown.

    • open

      void open(H aHandle) throws IOException
      Open/connect the component identified by the given handle.
      Parameters:
      aHandle - The handle identifying the component.
      Throws:
      IOException - in case opening/connecting fails.
      UnknownHandleRuntimeException - in case the given handle is unknown.
      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.

    • openUnchecked

      default void openUnchecked(H aHandle)
      Opens the component by calling open(Object) without you to require catching an IOException.
      Parameters:
      aHandle - The handle identifying the component.
      Throws:
      org.refcodes.exception.RuntimeIOException - encapsulates the aCause and is thrown upon encountering a IOException exception