View Javadoc

1   /*
2    * Copyright 2011-2013 smartics, Kronseder & Reiner GmbH
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 de.smartics.util.adapt;
17  
18  /**
19   * Implemented by a class to support different adapters to its instances.
20   */
21  public interface Adaptable
22  {
23    // ********************************* Fields *********************************
24  
25    // --- constants ------------------------------------------------------------
26  
27    // ****************************** Initializer *******************************
28  
29    // ****************************** Inner Classes *****************************
30  
31    // ********************************* Methods ********************************
32  
33    // --- get&set --------------------------------------------------------------
34  
35    // --- business -------------------------------------------------------------
36  
37    /**
38     * Returns the adapter of the requested type.
39     *
40     * @param type the type of the requested adapter.
41     * @return the adapter instance of the requested type
42     * @throws AdaptableException if this instance does not provide an adapter of
43     *           the requested type.
44     * @param <T> the type of the requested adapter.
45     */
46    <T> T as(Class<? extends T> type) throws AdaptableException;
47  
48    /**
49     * Checks if the instance provides an adapter for the desired type.
50     *
51     * @param type the type of the requested adapter.
52     * @return <code>true</code> if the instance provides the requested adapter,
53     *         <code>false</code> otherwise.
54     */
55    boolean isAdaptable(Class<?> type);
56  
57    // --- object basics --------------------------------------------------------
58  
59  }