org.apache.catalina.Contained Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package org.apache.catalina;


/**
 * Decoupling interface which specifies that an implementing class is
 * associated with at most one Container instance.
 *
 * @author Craig R. McClanahan
 * @author Peter Donald
 * @version $Id: Contained.java 1187801 2011-10-22 21:16:40Z markt $
 */

public interface Contained {


    //-------------------------------------------------------------- Properties


    /**
     * Return the Container with which this instance is associated
     * (if any); otherwise return null.
     */
    public Container getContainer();


    /**
     * Set the Container with which this instance is associated.
     *
     * @param container The Container instance with which this instance is to
     *  be associated, or null to disassociate this instance
     *  from any Container
     */
    public void setContainer(Container container);


}