com.hazelcast.config

## Class ItemListenerConfig

- java.lang.Object
- - com.hazelcast.config.ListenerConfig
  - - com.hazelcast.config.ItemListenerConfig

- All Implemented Interfaces:
    DataSerializable, IdentifiedDataSerializable
  Direct Known Subclasses:
    ItemListenerConfigReadOnly

      public class ItemListenerConfig
      extends ListenerConfig

  Contains the configuration for an Item Listener.

- - ### Field Summary

    - ### Fields inherited from class com.hazelcast.config.ListenerConfig

      `className, implementation`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `ItemListenerConfig()`
    `ItemListenerConfig(ItemListener implementation, boolean includeValue)`
    `ItemListenerConfig(ItemListenerConfig config)`
    `ItemListenerConfig(String className, boolean includeValue)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `equals(Object o)`
    `ItemListenerConfigReadOnly` | `getAsReadOnly()` Deprecated. this method will be removed in 4.0; it is meant for internal usage only
    `int` | `getId()` Returns type identifier for this class.
    `ItemListener` | `getImplementation()` Returns the EventListener implementation.
    `int` | `hashCode()`
    `boolean` | `isIncludeValue()`
    `void` | `readData(ObjectDataInput in)` Reads fields from the input stream
    `ItemListenerConfig` | `setImplementation(ItemListener implementation)`
    `ItemListenerConfig` | `setIncludeValue(boolean includeValue)`
    `String` | `toString()`
    `void` | `writeData(ObjectDataOutput out)` Writes object fields to output stream

    - ### Methods inherited from class com.hazelcast.config.ListenerConfig

      `getClassName, getFactoryId, isLocal, setClassName, setImplementation`

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

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### ItemListenerConfig

          public ItemListenerConfig()

    - #### ItemListenerConfig

          public ItemListenerConfig(String className,
                                    boolean includeValue)

    - #### ItemListenerConfig

          public ItemListenerConfig(ItemListener implementation,
                                    boolean includeValue)

    - #### ItemListenerConfig

          public ItemListenerConfig(ItemListenerConfig config)

  - ### Method Detail

    - #### getAsReadOnly

          public ItemListenerConfigReadOnly getAsReadOnly()

      Deprecated. this method will be removed in 4.0; it is meant for internal usage only
      Gets immutable version of this configuration.
      Overrides:
        `getAsReadOnly` in class `ListenerConfig`
      Returns:
        immutable version of this configuration

    - #### getImplementation

          public ItemListener getImplementation()

      Description copied from class: `ListenerConfig`
      Returns the EventListener implementation. If none has been specified, null is returned.
      Overrides:
        `getImplementation` in class `ListenerConfig`
      Returns:
        the EventListener implementation
      See Also:
        `ListenerConfig.setImplementation(java.util.EventListener)`

    - #### setImplementation

          public ItemListenerConfig setImplementation(ItemListener implementation)

    - #### isIncludeValue

          public boolean isIncludeValue()

      Overrides:
        `isIncludeValue` in class `ListenerConfig`

    - #### setIncludeValue

          public ItemListenerConfig setIncludeValue(boolean includeValue)

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `ListenerConfig`

    - #### equals

          public boolean equals(Object o)

      Overrides:
        `equals` in class `ListenerConfig`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `ListenerConfig`

    - #### getId

          public int getId()

      Description copied from interface: `IdentifiedDataSerializable`
      Returns type identifier for this class. It should be unique per DataSerializableFactory.
      Specified by:
        `getId` in interface `IdentifiedDataSerializable`
      Overrides:
        `getId` in class `ListenerConfig`
      Returns:
        type ID

    - #### writeData

          public void writeData(ObjectDataOutput out)
                         throws IOException

      Description copied from interface: `DataSerializable`
      Writes object fields to output stream
      Specified by:
        `writeData` in interface `DataSerializable`
      Overrides:
        `writeData` in class `ListenerConfig`
      Parameters:
        `out` - output
      Throws:
        `IOException` - if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

    - #### readData

          public void readData(ObjectDataInput in)
                        throws IOException

      Description copied from interface: `DataSerializable`
      Reads fields from the input stream
      Specified by:
        `readData` in interface `DataSerializable`
      Overrides:
        `readData` in class `ListenerConfig`
      Parameters:
        `in` - input
      Throws:
        `IOException` - if an I/O error occurs. In particular, an `IOException` may be thrown if the input stream has been closed.

Copyright © 2020. All rights reserved.