org.apache.turbine.om

## Class OMTool

- java.lang.Object
- - org.apache.turbine.om.OMTool

- All Implemented Interfaces:
    org.apache.fulcrum.pool.Recyclable, ApplicationTool

      public class OMTool
      extends Object
      implements ApplicationTool, org.apache.fulcrum.pool.Recyclable

  A Pull tool to make om objects available to a template
  Version:
    $Id: OMTool.java 1706425 2015-10-02 14:47:51Z tv $
  Author:
    John D. McNally, Henning P. Schmiedehausen

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `protected class` | `OMTool.PullHelper` Inner class to present a nice interface to the template designer

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected RetrieverFactory` | `omFactory` The Factory responsible for retrieving the objects from storage
    `protected ConcurrentHashMap<String,Object>` | `omMap`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `OMTool()` Default constructor

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `dispose()` Disposes the object after use.
    `OMTool.PullHelper` | `get(String omName)` Get the `OMTool.PullHelper` object with the given name
    `Object` | `get(String omName, String key)` Get the object with the given name and key
    `void` | `init(Object data)` Prepares tool for a single request
    `boolean` | `isDisposed()` Checks whether the recyclable has been disposed.
    `void` | `recycle()` Recycles the object for a new client.
    `void` | `refresh()` Implementation of ApplicationTool interface is not needed for this method as the tool is request scoped

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### omMap

          protected ConcurrentHashMap<String,Object> omMap

    - #### omFactory

          protected RetrieverFactory omFactory

      The Factory responsible for retrieving the objects from storage

  - ### Constructor Detail

    - #### OMTool

          public OMTool()
                 throws Exception

      Default constructor
      Throws:
        `Exception` - if creating the factory fails

  - ### Method Detail

    - #### init

          public void init(Object data)

      Prepares tool for a single request
      Specified by:
        `init` in interface `ApplicationTool`
      Parameters:
        `data` - the initialization data

    - #### refresh

          public void refresh()

      Implementation of ApplicationTool interface is not needed for this method as the tool is request scoped
      Specified by:
        `refresh` in interface `ApplicationTool`

    - #### get

          public OMTool.PullHelper get(String omName)
                                throws Exception

      Get the `OMTool.PullHelper` object with the given name
      Parameters:
        `omName` - the object name
      Returns:
        the PullHelper
      Throws:
        `Exception` - if retrieving the object fails

    - #### get

          public Object get(String omName,
                   String key)
                     throws Exception

      Get the object with the given name and key
      Parameters:
        `omName` - the object name
        `key` - the object key
      Returns:
        the object
      Throws:
        `Exception` - if retrieving the object fails

    - #### recycle

          public void recycle()

      Recycles the object for a new client. Recycle methods with parameters must be added to implementing object and they will be automatically called by pool implementations when the object is taken from the pool for a new client. The parameters must correspond to the parameters of the constructors of the object. For new objects, constructors can call their corresponding recycle methods whenever applicable. The recycle methods must call their super.
      Specified by:
        `recycle` in interface `org.apache.fulcrum.pool.Recyclable`

    - #### dispose

          public void dispose()

      Disposes the object after use. The method is called when the object is returned to its pool. The dispose method must call its super.
      Specified by:
        `dispose` in interface `org.apache.fulcrum.pool.Recyclable`

    - #### isDisposed

          public boolean isDisposed()

      Checks whether the recyclable has been disposed.
      Specified by:
        `isDisposed` in interface `org.apache.fulcrum.pool.Recyclable`
      Returns:
        true, if the recyclable is disposed.

Copyright © 2000-2015 The Apache Software Foundation. All Rights Reserved.