KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > catalina > Contained


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
18
19 package org.apache.catalina;
20
21
22 /**
23  * <p>Decoupling interface which specifies that an implementing class is
24  * associated with at most one <strong>Container</strong> instance.</p>
25  *
26  * @author Craig R. McClanahan
27  * @author Peter Donald
28  * @version $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $
29  */
30
31 public interface Contained {
32
33
34     //-------------------------------------------------------------- Properties
35
36
37     /**
38      * Return the <code>Container</code> with which this instance is associated
39      * (if any); otherwise return <code>null</code>.
40      */
41     public Container getContainer();
42
43
44     /**
45      * Set the <code>Container</code> with which this instance is associated.
46      *
47      * @param container The Container instance with which this instance is to
48      * be associated, or <code>null</code> to disassociate this instance
49      * from any Container
50      */
51     public void setContainer(Container container);
52
53
54 }
55
Popular Tags