Mark AD-SAL interfaces as deprecated
[controller.git] / opendaylight / adsal / sal / api / src / main / java / org / opendaylight / controller / sal / core / State.java
1
2 /*
3  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
4  *
5  * This program and the accompanying materials are made available under the
6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7  * and is available at http://www.eclipse.org/legal/epl-v10.html
8  */
9
10 package org.opendaylight.controller.sal.core;
11
12 import javax.xml.bind.annotation.XmlAccessType;
13 import javax.xml.bind.annotation.XmlAccessorType;
14 import javax.xml.bind.annotation.XmlElement;
15 import javax.xml.bind.annotation.XmlRootElement;
16
17 /**
18  * The class represents the State property of an Edge
19  *
20  *
21  */
22 @XmlRootElement
23 @XmlAccessorType(XmlAccessType.NONE)
24 @SuppressWarnings("serial")
25 @Deprecated
26 public class State extends Property {
27     @XmlElement(name="value")
28     private short stateValue;
29
30     public static final short EDGE_DOWN = 0;
31     public static final short EDGE_UP = 1;
32     public static final short EDGE_UNK = 0x7fff;
33     public static final String StatePropName = "state";
34
35     /*
36      * Private constructor used for JAXB mapping
37      */
38     private State() {
39         super(StatePropName);
40         this.stateValue = EDGE_UNK;
41     }
42
43     public State(short state) {
44         super(StatePropName);
45         this.stateValue = state;
46     }
47
48     @Override
49     public State clone() {
50         return new State(this.stateValue);
51     }
52
53     public short getValue() {
54         return this.stateValue;
55     }
56
57     @Override
58     public int hashCode() {
59         final int prime = 31;
60         int result = super.hashCode();
61         result = prime * result + stateValue;
62         return result;
63     }
64
65     @Override
66     public boolean equals(Object obj) {
67         if (this == obj)
68             return true;
69         if (!super.equals(obj))
70             return false;
71         if (getClass() != obj.getClass())
72             return false;
73         State other = (State) obj;
74         if (stateValue != other.stateValue)
75             return false;
76         return true;
77     }
78
79     @Override
80     public String toString() {
81         return "State[" + stateValue + "]";
82     }
83
84     @Override
85     public String getStringValue() {
86         if (stateValue == 0) {
87             return ("EDGE_DOWN");
88         } else if (stateValue == 1) {
89             return ("EDGE_UP");
90         } else if (stateValue == 0x7fff) {
91             return ("EDGE_UNK");
92         } else {
93             return String.valueOf(stateValue);
94         }
95     }
96 }