1 package org.apache.turbine.om;
2
3
4 /*
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements. See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership. The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License. You may obtain a copy of the License at
12 *
13 * http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied. See the License for the
19 * specific language governing permissions and limitations
20 * under the License.
21 */
22
23
24 /**
25 * This interface marks a class that has a retrieve(String) method.
26 *
27 * @author <a href="mailto:jmcnally@collab.net">John D. McNally</a>
28 * @version $Id$
29 *
30 * @deprecated cft. deprecation comment in {@link OMTool}.
31 */
32 @Deprecated
33 public interface Retriever
34 {
35 /**
36 * Gets an object of the same type as the object implementing
37 * this method according to the key.
38 *
39 * @param key the key for the object
40 * @return the object that matches the key
41 * @throws Exception if something goes wrong
42 */
43 Object retrieve(String key)
44 throws Exception;
45 }