misc/env/src/main/java/org/onap/aaf/misc/env/Creatable.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 package org.onap.aaf.misc.env;\r
  23 \r
  24 \r
  25 /**\r
  26  * <h1>Creatable</h1>\r
  27  * <b>**Must implement constructor T(ENV env, long currentTimeMillis);**</b><p>\r
  28  *\r
  29  * This interface exists to cover basic LifeCycle semantics so that Objects\r
  30  * can be created dynamically and managed at a basic level (destroy(env)).\r
  31  * \r
  32  * @author Jonathan\r
  33  *\r
  34  * @param <T>\r
  35  */\r
  36 public interface Creatable<T> {\r
  37     /**\r
  38      * Return the timestamp (Unix long) when this object was created.<p>\r
  39      * This can be used to see if the object is out of date in certain\r
  40      * circumstances, or perhaps has already been notified in others.\r
  41      * \r
  42      * @return long\r
  43      */\r
  44     public abstract long created();\r
  45     \r
  46     /**\r
  47      * Allow LifeCycle aware process to signal this element as destroyed.\r
  48      *  \r
  49      * @param env\r
  50      */\r
  51     public abstract void destroy(Env env);\r
  52 }\r