env/src/main/java/com/att/inno/env/Creatable.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START====================================================\r
   3  * * org.onap.aai\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * Copyright © 2017 Amdocs\r
   7  * * ===========================================================================\r
   8  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   9  * * you may not use this file except in compliance with the License.\r
  10  * * You may obtain a copy of the License at\r
  11  * * \r
  12  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  13  * * \r
  14  *  * Unless required by applicable law or agreed to in writing, software\r
  15  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  16  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  17  * * See the License for the specific language governing permissions and\r
  18  * * limitations under the License.\r
  19  * * ============LICENSE_END====================================================\r
  20  * *\r
  21  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  22  * *\r
  23  ******************************************************************************/\r
  24 package com.att.inno.env;\r
  25 \r
  26 \r
  27 /**\r
  28  * <h1>Creatable</h1>\r
  29  * <b>**Must implement constructor T(ENV env, long currentTimeMillis);**</b><p>\r
  30  *\r
  31  * This interface exists to cover basic LifeCycle semantics so that Objects\r
  32  * can be created dynamically and managed at a basic level (destroy(env)).\r
  33  * \r
  34  *\r
  35  * @param <T>\r
  36  */\r
  37 public interface Creatable<T> {\r
  38         /**\r
  39          * Return the timestamp (Unix long) when this object was created.<p>\r
  40          * This can be used to see if the object is out of date in certain\r
  41          * circumstances, or perhaps has already been notified in others.\r
  42          * \r
  43          * @return long\r
  44          */\r
  45         public abstract long created();\r
  46         \r
  47         /**\r
  48          * Allow LifeCycle aware process to signal this element as destroyed.\r
  49          *  \r
  50          * @param env\r
  51          */\r
  52         public abstract void destroy(Env env);\r
  53 }\r