Merge "Gracefully stop HT threads when the bundle is being stopped (cache terminated...
[controller.git] / opendaylight / sal / api / src / main / java / org / opendaylight / controller / sal / utils / Status.java
index 2fbb3e55f841eb80db4f5397b3913683cd77c5cc..a7a44456cc3011ec6e1957395f65dbcf2fccd9af 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved. 
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
@@ -8,12 +8,14 @@
 
 package org.opendaylight.controller.sal.utils;
 
+import java.io.Serializable;
+
 /**
  * Represents the return object of the osgi service interfaces function calls.
  * It contains a code {@code StatusCode} representing the result of the call and
  * a string which describes a failure reason (if any) in human readable form.
  */
-public class Status {
+public class Status implements Serializable {
     private StatusCode code;
     private String description;
     private long requestId;
@@ -23,7 +25,7 @@ public class Status {
      * for internal API2 function calls. This constructor allows to specify,
      * beside the Status Code, a custom human readable description to add more
      * information about the status.
-     * 
+     *
      * @param errorCode
      *            The status code. If passed as null, code will be stored as
      *            {@code StatusCode.UNDEFINED}
@@ -42,7 +44,7 @@ public class Status {
      * Generates an instance of the Status class based on the passed StatusCode
      * only. The description field of the Status object will be inferred by the
      * status code.
-     * 
+     *
      * @param errorCode
      *            The status code. If passed as null, code will be stored as
      *            {@code StatusCode.UNDEFINED}
@@ -59,7 +61,7 @@ public class Status {
      * asynchronous call. It is supposed to be created by the underlying
      * infrastructure only when it was successful in allocating the asynchronous
      * request id, hence caller should expect StatusCode to be successful.
-     * 
+     *
      * @param errorCode
      *            The status code. If passed as null, code will be stored as
      *            {@code StatusCode.UNDEFINED}
@@ -76,7 +78,7 @@ public class Status {
 
     /**
      * Returns the status code
-     * 
+     *
      * @return the {@code StatusCode} representing the status code
      */
     public StatusCode getCode() {
@@ -85,7 +87,7 @@ public class Status {
 
     /**
      * Returns a human readable description of the failure if any
-     * 
+     *
      * @return a string representing the reason of failure
      */
     public String getDescription() {
@@ -94,7 +96,7 @@ public class Status {
 
     /**
      * Tells whether the status is successful
-     * 
+     *
      * @return true if the Status code is {@code StatusCode.SUCCESS}
      */
     public boolean isSuccess() {
@@ -105,7 +107,7 @@ public class Status {
      * Return the request id assigned by underlying infrastructure in case of
      * asynchronous request. In case of synchronous requests, the returned id
      * is expected to be 0
-     * 
+     *
      * @return The request id assigned for this asynchronous request
      */
     public long getRequestId() {