Class NotificationFilterSupport

    • Constructor Detail

      • NotificationFilterSupport

        public NotificationFilterSupport​()
    • Method Detail

      • isNotificationEnabled

        public boolean isNotificationEnabled​(Notification notification)
        Invoked before sending the specified notification to the listener.
        This filter compares the type of the specified notification with each enabled type. If the notification type matches one of the enabled types, the notification should be sent to the listener and this method returns true.
        Specified by:
        isNotificationEnabled in interface NotificationFilter
        Parameters:
        notification - The notification to be sent.
        Returns:
        true if the notification should be sent to the listener, false otherwise.
      • enableType

        public void enableType​(String prefix)
                        throws IllegalArgumentException
        Enables all the notifications the type of which starts with the specified prefix to be sent to the listener.
        If the specified prefix is already in the list of enabled notification types, this method has no effect.

        Example:

         // Enables all notifications the type of which starts with "my_example" to be sent.
         myFilter.enableType("my_example");
         // Enables all notifications the type of which is "my_example.my_type" to be sent.
         myFilter.enableType("my_example.my_type");
         
        Note that:
        myFilter.enableType("my_example.*");
        will no match any notification type.
        Parameters:
        prefix - The prefix.
        Throws:
        IllegalArgumentException - The prefix parameter is null.
      • disableType

        public void disableType​(String prefix)
        Removes the given prefix from the prefix list.
        If the specified prefix is not in the list of enabled notification types, this method has no effect.
        Parameters:
        prefix - The prefix.
      • disableAllTypes

        public void disableAllTypes​()
        Disables all notification types.
      • getEnabledTypes

        public Vector<String> getEnabledTypes​()
        Gets all the enabled notification types for this filter.
        Returns:
        The list containing all the enabled notification types.