View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.betwixt.strategy;
18  
19  import org.apache.commons.betwixt.AttributeDescriptor;
20  
21  /***
22   * Strategy to determine whether to show an attribute at all.
23   * @since 0.8
24   */
25  public interface AttributeSuppressionStrategy 
26  {
27      /***
28       * Should the attribute described as given be suppressed during introspection?
29       * @param descriptor <code>AttributeDescriptor</code>, not null
30       * @return true if the attribute should be ignore,
31       * false otherwise
32       */
33      public boolean suppress(AttributeDescriptor descriptor);
34      
35      /***
36       * Default strategy: show all attributes.
37       */
38      public final static AttributeSuppressionStrategy DEFAULT = new AttributeSuppressionStrategy() {
39          public boolean suppress(AttributeDescriptor description) {
40              return false;
41          }
42  
43      };
44  }