IClosePool

All Known Implementing Classes:: UncloseableClosePool

public interface IClosePool

Author:: Silvan Wyss

Method Summary

Modifier and Type

Method

Description

void

addElements(IContainer<GroupCloseable> elements)

Adds the given elements to the current IClosePool.

void

closeElementsIfStateIsOpen()

Closes the elements of the current IClosePool if the state of the current IClosePool is CloseState.OPEN.

CloseState

getState()

IContainer<GroupCloseable>

getStoredElements()

Method Details
- addElements
  
  void addElements(IContainer<GroupCloseable> elements)
  
  Adds the given elements to the current IClosePool.
  
  Parameters:
  
  elements -
  
  Throws:
  
  RuntimeException - if one of the given elements is null.
  
  RuntimeException - if the current IClosePool contains already one of the given elements.
- closeElementsIfStateIsOpen
  
  void closeElementsIfStateIsOpen()
  
  Closes the elements of the current IClosePool if the state of the current IClosePool is CloseState.OPEN.
- getStoredElements
  
  IContainer<GroupCloseable> getStoredElements()
  
  Returns:
  
  the elements of the current IClosePool.
- getState
  
  CloseState getState()
  
  Returns:
  
  the state of the current IClosePool.