View Javadoc

1   /*
2    * $Id: DefinitionDAO.java 666834 2008-06-11 20:49:05Z apetrelli $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   * http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  package org.apache.tiles.definition.dao;
22  
23  import java.util.Map;
24  
25  import org.apache.tiles.Definition;
26  
27  /***
28   * It represents an object that provides definitions, depending on a
29   * customization key.
30   *
31   * @param <K> The customization key class.
32   * @version $Rev: 666834 $ $Date: 2008-06-11 22:49:05 +0200 (mer, 11 giu 2008) $
33   * @since 2.1.0
34   */
35  public interface DefinitionDAO<K> {
36  
37      /***
38       * Returns a definition, given its name and the customization key.
39       *
40       * @param name The name of the definition.
41       * @param customizationKey The customization key.
42       * @return The requested definition, if found, otherwise <code>null</code>.
43       * The inheritance of the definition must not be resolved.
44       * @since 2.1.0
45       */
46      Definition getDefinition(String name, K customizationKey);
47  
48      /***
49       * Returns all the definitions used of a customization key.
50       *
51       * @param customizationKey The customization key.
52       * @return All the definitions that are connected to the customization key.
53       * The inheritance of the definitions must not be resolved.
54       * @since 2.1.0
55       */
56      Map<String, Definition> getDefinitions(K customizationKey);
57  }