Imported Upstream version 1.0.0

[platform/upstream/iotivity.git] / android / android_api / base / src / main / java / org / iotivity / base / QualityOfService.java

diff --git a/android/android_api/base/src/main/java/org/iotivity/base/QualityOfService.java b/android/android_api/base/src/main/java/org/iotivity/base/QualityOfService.java
index 4c85981..e6d6659 100644 (file)
--- a/android/android_api/base/src/main/java/org/iotivity/base/QualityOfService.java
+++ b/android/android_api/base/src/main/java/org/iotivity/base/QualityOfService.java
@@ -1,42 +1,58 @@
-/*\r
- * //******************************************************************\r
- * //\r
- * // Copyright 2015 Intel Corporation.\r
- * //\r
- * //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\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
- * //\r
- * //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\r
- */\r
-\r
-package org.iotivity.base;\r
-\r
-/**\r
- */\r
-public enum QualityOfService {\r
-    LOW(0),\r
-    MEDIUM(1),\r
-    HIGH(2),\r
-    NA(3);\r
-\r
-    private int value;\r
-\r
-    private QualityOfService(int value) {\r
-        this.value = value;\r
-    }\r
-\r
-    public int getValue() {\r
-        return this.value;\r
-    }\r
-}\r
+/*
+ * //******************************************************************
+ * //
+ * // Copyright 2015 Intel Corporation.
+ * //
+ * //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+ * //
+ * // 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.
+ * //
+ * //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+ */
+
+package org.iotivity.base;
+
+/**
+ * Quality of Service attempts to abstract the guarantees provided by the underlying transport
+ * protocol. The precise definitions of each quality of service level depend on the
+ * implementation. In descriptions below are for the current implementation and may changed
+ * over time.
+ */
+public enum QualityOfService {
+    /**
+     * Packet delivery is best effort.
+     */
+    LOW(0),
+    /**
+     * Packet delivery is best effort.
+     */
+    MEDIUM(1),
+    /**
+     * Acknowledgments are used to confirm delivery.
+     */
+    HIGH(2),
+    /**
+     * No Quality is defined, let the stack decide.
+     */
+    NA(3);
+
+    private int value;
+
+    private QualityOfService(int value) {
+        this.value = value;
+    }
+
+    public int getValue() {
+        return this.value;
+    }
+}