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

   1 /**\r
   2  * ============LICENSE_START====================================================\r
   3  * org.onap.aaf\r
   4  * ===========================================================================\r
   5  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.\r
   6  * ===========================================================================\r
   7  * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * you may not use this file except in compliance with the License.\r
   9  * You may obtain a copy of the License at\r
  10  * \r
  11  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * \r
  13  * Unless required by applicable law or agreed to in writing, software\r
  14  * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * See the License for the specific language governing permissions and\r
  17  * limitations under the License.\r
  18  * ============LICENSE_END====================================================\r
  19  *\r
  20  */\r
  21 \r
  22 /**\r
  23  * \r
  24  */\r
  25 package org.onap.aaf.misc.env.impl;\r
  26 \r
  27 import org.onap.aaf.misc.env.APIException;\r
  28 import org.onap.aaf.misc.env.Env;\r
  29 import org.onap.aaf.misc.env.LifeCycle;\r
  30 \r
  31 \r
  32 \r
  33 /**\r
  34  * <h1>NullLifeCycle</h1>\r
  35  * \r
  36  * This is a convenience class for those Objects which should\r
  37  * implement LifeCycle, but don't have anything to do in any of the \r
  38  * LifeCycle methods defined. Extending\r
  39  * NullLifeCycle reduces the required methods for the class by 5.  \r
  40  * Any one or two of them can be overloaded.<p>\r
  41  * \r
  42  * If more are overloaded, it is\r
  43  * recommended just to implement LifeCycle.\r
  44  * <p>\r
  45  * \r
  46  * This only works, though, if the Object doesn't need to extend something\r
  47  * else, due to Java's Single Extension policy.  In other cases, just\r
  48  * implement LifeCycle, and leave them empty.\r
  49  * \r
  50  * @author Jonathan\r
  51  *\r
  52  */\r
  53 public class NullLifeCycle implements LifeCycle {\r
  54     public void servicePrestart(Env env) throws APIException {}\r
  55     public void threadPrestart(Env env) throws APIException {}\r
  56     public void refresh(Env env) throws APIException {}\r
  57     public void threadDestroy(Env env) throws APIException {}\r
  58     public void serviceDestroy(Env env) throws APIException {}\r
  59 }