Fix a warning and make field final
[controller.git] / opendaylight / commons / protocol-framework / src / main / java / org / opendaylight / protocol / framework / DocumentedException.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.protocol.framework;
9
10 /**
11  * Documented exception occurrs when an error is thrown that is documented
12  * in any RFC or draft for the specific protocol.
13  *
14  * @deprecated This exception no longer carries any special meaning. Users
15  * are advised to stop using it and define their own replacement.
16  */
17 @Deprecated
18 public class DocumentedException extends Exception  {
19
20     private static final long serialVersionUID = -3727963789710833704L;
21
22     /**
23      * Creates a documented exception
24      * @param message string
25      */
26     public DocumentedException(final String message) {
27         super(message);
28     }
29
30     /**
31      * Creates a documented exception
32      * @param err string
33      * @param cause the cause (which is saved for later retrieval by the
34      * Throwable.getCause() method). (A null value is permitted, and indicates
35      * that the cause is nonexistent or unknown.)
36      */
37     public DocumentedException(final String err, final Exception cause) {
38         super(err, cause);
39     }
40 }