Class FilteredSharedChannelOutputWrapper

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.Object synchObject
      The synchronization object to protect the writers from each other when they read data or update the write filters.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addWriteFilter​(Filter filter)
      Installs a write filter defining a transformation to be applied by the write method of the channel end.
      void addWriteFilter​(Filter filter, int index)
      Installs a write filter defining a transformation to be applied by the write method of the channel end at a specific index.
      Filter getWriteFilter​(int index)
      Returns the write filter installed at the given index.
      int getWriteFilterCount()
      Returns the number of write filters currently installed.
      void removeWriteFilter​(int index)
      Removes the write filter installed at the given index.
      void removeWriteFilter​(Filter filter)
      Removes the first write filter (lowest index) matching the filter given as a parameter.
      void write​(java.lang.Object data)
      Writes a value to the channel.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • synchObject

        private java.lang.Object synchObject
        The synchronization object to protect the writers from each other when they read data or update the write filters.
    • Constructor Detail

      • FilteredSharedChannelOutputWrapper

        public FilteredSharedChannelOutputWrapper​(SharedChannelOutput out)
        Constructs a new wrapper for the given channel output end.
        Parameters:
        out - the existing channel end.
    • Method Detail

      • addWriteFilter

        public void addWriteFilter​(Filter filter)
        Description copied from interface: WriteFiltered
        Installs a write filter defining a transformation to be applied by the write method of the channel end. The filter will be appended to the end of the current list, making it the last to be applied.
        Specified by:
        addWriteFilter in interface WriteFiltered
        Overrides:
        addWriteFilter in class FilteredChannelOutputWrapper
        Parameters:
        filter - the filter to be installed; may not be null.
      • addWriteFilter

        public void addWriteFilter​(Filter filter,
                                   int index)
        Description copied from interface: WriteFiltered
        Installs a write filter defining a transformation to be applied by the write method of the channel end at a specific index. If there is already a filter at that index position the existing filters are shifted to make room. If the index is greater than the number of filters already installed the filter is placed at the end.
        Specified by:
        addWriteFilter in interface WriteFiltered
        Overrides:
        addWriteFilter in class FilteredChannelOutputWrapper
        Parameters:
        filter - the filter to be installed; may not be null.
        index - the zero based index; may not be negative.
      • removeWriteFilter

        public void removeWriteFilter​(Filter filter)
        Description copied from interface: WriteFiltered
        Removes the first write filter (lowest index) matching the filter given as a parameter. The filter removed, r, will satisfy the condition r.equals (filter). The remaining filters are shifted to close the gap in the index allocation.
        Specified by:
        removeWriteFilter in interface WriteFiltered
        Overrides:
        removeWriteFilter in class FilteredChannelOutputWrapper
        Parameters:
        filter - the filter to be removed; may not be null.
      • removeWriteFilter

        public void removeWriteFilter​(int index)
        Description copied from interface: WriteFiltered
        Removes the write filter installed at the given index. The remaining filters are shifted to close the gap in the index allocation.
        Specified by:
        removeWriteFilter in interface WriteFiltered
        Overrides:
        removeWriteFilter in class FilteredChannelOutputWrapper
        Parameters:
        index - zero-based index of the filter to be removed.