Increase coverage for Env module
[aaf/authz.git] / misc / env / src / main / java / org / onap / aaf / misc / env / Slot.java
index e202472..f79d12d 100644 (file)
-/**
- * ============LICENSE_START====================================================
- * org.onap.aaf
- * ===========================================================================
- * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
- * ===========================================================================
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ============LICENSE_END====================================================
- *
- */
-
-/**
- * Slot.java
- *
- * Created on: Dec 5, 2008
- * Created by: Jonathan
- *
- * (c) 2008 SBC Knowledge Ventures, L.P. All rights reserved.
- ******************************************************************* 
- * RESTRICTED - PROPRIETARY INFORMATION The Information contained 
- * herein is for use only by authorized employees of AT&T Services, 
- * Inc., and authorized Affiliates of AT&T Services, Inc., and is 
- * not for general distribution within or outside the respective 
- * companies. 
- *******************************************************************
- */
-package org.onap.aaf.misc.env;
-
-/**
- * Slot's are used to store and retrieve data in the transaction's State object.
- */
-public final class Slot {
-       
-       /*
-        * The name of the Slot.
-        */
-       private final String key;
-       
-       /*
-        * The index of the State's local map associated with this Slot.
-        */
-       final int slot; 
-       
-       /**
-        * Constructs a new Slot.
-        * 
-        * @param index
-        *                      The index of State's local map this Slot is associated with.
-        * @param name
-        *                      The name of the Slot's key.
-        */
-       Slot(int index, String name) {
-               slot = index;
-               key = name;
-       }
-       
-       /**
-        * Debug method only to print key=slot pairs.
-        */
-       public String toString() {
-               return key + '=' + slot;
-       }
-       
-       /**
-        * Returns the name of this Slot's key.
-        * 
-        * @return
-        *                      The name of this Slot's key.
-        */
-       public String getKey() {
-               return key;
-       }
-       
-       /**
-        * Put an Object into the slot on the State
-        * @param state
-        * @param obj
-        */
-       public void put(Object[] state, Object obj) {
-               state[slot]=obj;
-       }
-
-       /**
-        * Get an Object from the slot on the State
-        * @param state
-        * @param obj
-        */
-       public Object get(Object[] state) {
-               return state[slot];
-       }
-
-}
+/**\r
+ * ============LICENSE_START====================================================\r
+ * org.onap.aaf\r
+ * ===========================================================================\r
+ * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.\r
+ * ===========================================================================\r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ * \r
+ *      http://www.apache.org/licenses/LICENSE-2.0\r
+ * \r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ * ============LICENSE_END====================================================\r
+ *\r
+ */\r
+\r
+/**\r
+ * Slot.java\r
+ *\r
+ * Created on: Dec 5, 2008\r
+ * Created by: Jonathan\r
+ *\r
+ * (c) 2008 SBC Knowledge Ventures, L.P. All rights reserved.\r
+ ******************************************************************* \r
+ * RESTRICTED - PROPRIETARY INFORMATION The Information contained \r
+ * herein is for use only by authorized employees of AT&T Services, \r
+ * Inc., and authorized Affiliates of AT&T Services, Inc., and is \r
+ * not for general distribution within or outside the respective \r
+ * companies. \r
+ *******************************************************************\r
+ */\r
+package org.onap.aaf.misc.env;\r
+\r
+/**\r
+ * Slot's are used to store and retrieve data in the transaction's State object.\r
+ */\r
+public final class Slot {\r
+       \r
+       /*\r
+        * The name of the Slot.\r
+        */\r
+       private final String key;\r
+       \r
+       /*\r
+        * The index of the State's local map associated with this Slot.\r
+        */\r
+       final int slot; \r
+       \r
+       /**\r
+        * Constructs a new Slot.\r
+        * \r
+        * @param index\r
+        *                      The index of State's local map this Slot is associated with.\r
+        * @param name\r
+        *                      The name of the Slot's key.\r
+        */\r
+       Slot(int index, String name) {\r
+               slot = index;\r
+               key = name;\r
+       }\r
+       \r
+       /**\r
+        * Debug method only to print key=slot pairs.\r
+        */\r
+       public String toString() {\r
+               return key + '=' + slot;\r
+       }\r
+       \r
+       /**\r
+        * Returns the name of this Slot's key.\r
+        * \r
+        * @return\r
+        *                      The name of this Slot's key.\r
+        */\r
+       public String getKey() {\r
+               return key;\r
+       }\r
+       \r
+       /**\r
+        * Put an Object into the slot on the State\r
+        * @param state\r
+        * @param obj\r
+        */\r
+       public void put(Object[] state, Object obj) {\r
+               state[slot]=obj;\r
+       }\r
+\r
+       /**\r
+        * Get an Object from the slot on the State\r
+        * @param state\r
+        * @param obj\r
+        */\r
+       public Object get(Object[] state) {\r
+               return state[slot];\r
+       }\r
+\r
+}\r