1
2
3 /*
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
5 *
6 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
7 *
8 * Portions Copyright Apache Software Foundation.
9 *
10 * The contents of this file are subject to the terms of either the GNU
11 * General Public License Version 2 only ("GPL") or the Common Development
12 * and Distribution License("CDDL") (collectively, the "License"). You
13 * may not use this file except in compliance with the License. You can obtain
14 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
15 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
16 * language governing permissions and limitations under the License.
17 *
18 * When distributing the software, include this License Header Notice in each
19 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
20 * Sun designates this particular file as subject to the "Classpath" exception
21 * as provided by Sun in the GPL Version 2 section of the License file that
22 * accompanied this code. If applicable, add the following below the License
23 * Header, with the fields enclosed by brackets [] replaced by your own
24 * identifying information: "Portions Copyrighted [year]
25 * [name of copyright owner]"
26 *
27 * Contributor(s):
28 *
29 * If you wish your version of this file to be governed by only the CDDL or
30 * only the GPL Version 2, indicate your decision by adding "[Contributor]
31 * elects to include this software in this distribution under the [CDDL or GPL
32 * Version 2] license." If you don't indicate a single choice of license, a
33 * recipient has the option to distribute your version of this file under
34 * either the CDDL, the GPL Version 2 or to extend the choice of license to
35 * its licensees as provided above. However, if you add GPL Version 2 code
36 * and therefore, elected the GPL Version 2 license, then the option applies
37 * only if the new code is made subject to such option by the copyright
38 * holder.
39 */
40
41
42 package org.apache.catalina;
43
44
45 /**
46 * <p>Decoupling interface which specifies that an implementing class is
47 * associated with at most one <strong>Container</strong> instance.</p>
48 *
49 * @author Craig R. McClanahan
50 * @author Peter Donald
51 * @version $Revision: 1.3 $ $Date: 2007/05/05 05:31:51 $
52 */
53
54 public interface Contained {
55
56
57 //-------------------------------------------------------------- Properties
58
59
60 /**
61 * Return the <code>Container</code> with which this instance is associated
62 * (if any); otherwise return <code>null</code>.
63 */
64 public Container getContainer();
65
66
67 /**
68 * Set the <code>Container</code> with which this instance is associated.
69 *
70 * @param container The Container instance with which this instance is to
71 * be associated, or <code>null</code> to disassociate this instance
72 * from any Container
73 */
74 public void setContainer(Container container);
75
76
77 }