misc/env/src/main/java/org/onap/aaf/misc/env/impl/NullLifeCycle.java

   1 /**
   2  * ============LICENSE_START====================================================
   3  * org.onap.aaf
   4  * ===========================================================================
   5  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   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  * ============LICENSE_END====================================================
  19  *
  20  */
  21
  22 /**
  23  *
  24  */
  25 package org.onap.aaf.misc.env.impl;
  26
  27 import org.onap.aaf.misc.env.APIException;
  28 import org.onap.aaf.misc.env.Env;
  29 import org.onap.aaf.misc.env.LifeCycle;
  30
  31
  32
  33 /**
  34  * <h1>NullLifeCycle</h1>
  35  *
  36  * This is a convenience class for those Objects which should
  37  * implement LifeCycle, but don't have anything to do in any of the
  38  * LifeCycle methods defined. Extending
  39  * NullLifeCycle reduces the required methods for the class by 5.
  40  * Any one or two of them can be overloaded.<p>
  41  *
  42  * If more are overloaded, it is
  43  * recommended just to implement LifeCycle.
  44  * <p>
  45  *
  46  * This only works, though, if the Object doesn't need to extend something
  47  * else, due to Java's Single Extension policy.  In other cases, just
  48  * implement LifeCycle, and leave them empty.
  49  *
  50  * @author Jonathan
  51  *
  52  */
  53 public class NullLifeCycle implements LifeCycle {
  54         public void servicePrestart(Env env) throws APIException {}
  55         public void threadPrestart(Env env) throws APIException {}
  56         public void refresh(Env env) throws APIException {}
  57         public void threadDestroy(Env env) throws APIException {}
  58         public void serviceDestroy(Env env) throws APIException {}
  59 }