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     */ 
017    package org.apache.commons.betwixt.strategy;
018    
019    import org.apache.commons.betwixt.ElementDescriptor;
020    
021    /**
022     * Strategy to determine whether to show an element at all.
023     * @since 0.8
024     */
025    public interface ElementSuppressionStrategy {
026        /**
027         * Should the element described as given be suppressed?
028         * @param descriptor <code>ElementDescriptor</code>, not null
029         * @return true if the desciptor should be ignored during introspection,
030         * false otherwise
031         */
032        public boolean suppress(ElementDescriptor descriptor);
033        
034        /**
035         * Default strategy: show all elements.
036         */
037        public final static ElementSuppressionStrategy DEFAULT = new ElementSuppressionStrategy() {
038            public boolean suppress(ElementDescriptor descr) {
039                return false;
040            }
041        };
042    }