View Javadoc

    1   package org.apache.stratum.lifecycle;
    2
    3   /*
    4    * Copyright 2001-2005 The Apache Software Foundation or its licensors,
    5    * as applicable.
    6    *
    7    * Licensed under the Apache License, Version 2.0 (the "License");
    8    * you may not use this file except in compliance with the License.
    9    * You may obtain a copy of the License at
    10   *
    11   *     http://www.apache.org/licenses/LICENSE-2.0
    12   *
    13   * Unless required by applicable law or agreed to in writing, software
    14   * distributed under the License is distributed on an "AS IS" BASIS,
    15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    16   * See the License for the specific language governing permissions and
    17   * limitations under the License.
    18   */
    19
    20  /***
    21   * The Suspendable interface is used when a component will need to temporarily halt execution of a component. The execution may be
    22   * halted so that you can reconfigure/ recompose/recontextualize component.
    23   *
    24   * @author <a href="mailto:donaldp@apache.org">Peter Donald</a>
    25   * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
    26   */
    27  public interface Suspendable
    28  {
    29      /***
    30       * Suspends the component.
    31       */
    32      void suspend();
    33
    34      /***
    35       * Resumes the component.
    36       */
    37      void resume();
    38  }