001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.feedback;
018
019import java.util.function.Predicate;
020
021import org.apache.wicket.util.io.IClusterable;
022
023/**
024 * Interface for filtering feedback messages.
025 * 
026 * @author Jonathan Locke
027 */
028@FunctionalInterface
029public interface IFeedbackMessageFilter extends IClusterable, Predicate<FeedbackMessage>
030{
031        /**
032         * Filter that returns simply all available messages.
033         */
034        IFeedbackMessageFilter ALL = message -> true;
035
036        /**
037         * Filter that does not match any message
038         */
039        IFeedbackMessageFilter NONE = message -> false;
040
041        /**
042         * @param message
043         *            The message to test for inclusion
044         * @return True if the message should be included, false to exclude it
045         */
046        boolean accept(FeedbackMessage message);
047
048        @Override
049        default boolean test(FeedbackMessage message) {
050                return accept(message);
051        }
052}