View Javadoc

1   /*
2    *  Copyright 2001-2013 Stephen Colebourne
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  package org.joda.beans;
17  
18  /**
19   * A query based on beans.
20   * <p>
21   * The query interface provides the simplest way to query beans.
22   * 
23   * @param <P>  the type of the property content
24   * @author Stephen Colebourne
25   */
26  public interface BeanQuery<P> {
27  
28      /**
29       * Queries a value from the specified bean.
30       * <p>
31       * This returns a value of some kind derived from the specified bean.
32       * This might be a property value or some other derived value.
33       * 
34       * @param bean  the bean to query, not null
35       * @return the value derived from the specified bean, may be null
36       * @throws ClassCastException if the bean is of an incorrect type
37       * @throws UnsupportedOperationException if unable to query
38       */
39      P get(Bean bean);
40  
41  }