Fix to remove camel case for Northbound API
[controller.git] / opendaylight / 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.XmlElement;
13 import javax.xml.bind.annotation.XmlRootElement;
14
15 /**
16  * The class represents the State property of an Edge
17  *
18  *
19  */
20 @XmlRootElement
21 @SuppressWarnings("serial")
22 public class State extends Property {
23     @XmlElement(name="value")
24     private short stateValue;
25
26     public static final short EDGE_DOWN = 0;
27     public static final short EDGE_UP = 1;
28     public static final short EDGE_UNK = 0x7fff;
29     public static final String StatePropName = "state";
30
31     /*
32      * Private constructor used for JAXB mapping
33      */
34     private State() {
35         super(StatePropName);
36         this.stateValue = EDGE_UNK;
37     }
38
39     public State(short state) {
40         super(StatePropName);
41         this.stateValue = state;
42     }
43
44     @Override
45     public State clone() {
46         return new State(this.stateValue);
47     }
48
49     public short getValue() {
50         return this.stateValue;
51     }
52
53     @Override
54     public int hashCode() {
55         final int prime = 31;
56         int result = super.hashCode();
57         result = prime * result + stateValue;
58         return result;
59     }
60
61     @Override
62     public boolean equals(Object obj) {
63         if (this == obj)
64             return true;
65         if (!super.equals(obj))
66             return false;
67         if (getClass() != obj.getClass())
68             return false;
69         State other = (State) obj;
70         if (stateValue != other.stateValue)
71             return false;
72         return true;
73     }
74
75     @Override
76     public String toString() {
77         return "State[" + stateValue + "]";
78     }
79 }