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.AttributeDescriptor;
020    
021    /**
022     * Strategy to determine whether to show an attribute at all.
023     * @since 0.8
024     */
025    public interface AttributeSuppressionStrategy 
026    {
027        /**
028         * Should the attribute described as given be suppressed during introspection?
029         * @param descriptor <code>AttributeDescriptor</code>, not null
030         * @return true if the attribute should be ignore,
031         * false otherwise
032         */
033        public boolean suppress(AttributeDescriptor descriptor);
034        
035        /**
036         * Default strategy: show all attributes.
037         */
038        public final static AttributeSuppressionStrategy DEFAULT = new AttributeSuppressionStrategy() {
039            public boolean suppress(AttributeDescriptor description) {
040                return false;
041            }
042    
043        };
044    }