src/main/kotlin/net/pterodactylus/sone/notify/ListNotificationFilter.kt

   1 /*
   2  * Sone - ListNotificationFilter.kt - Copyright © 2010–2020 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package net.pterodactylus.sone.notify
  18
  19 import com.google.inject.ImplementedBy
  20 import net.pterodactylus.sone.data.Sone
  21 import net.pterodactylus.util.notify.Notification
  22
  23 /**
  24  * Filters [list notifications][ListNotification], depending on the current
  25  * [Sone] and [its options][Sone.getOptions].
  26  */
  27 @ImplementedBy(DefaultListNotificationFilter::class)
  28 interface ListNotificationFilter {
  29
  30         fun filterNotifications(notifications: Collection<Notification>, currentSone: Sone?): Collection<Notification>
  31
  32 }