Initial opendaylight infrastructure commit!!
[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 org.apache.commons.lang3.builder.HashCodeBuilder;
13 import org.apache.commons.lang3.builder.EqualsBuilder;
14 import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
15
16 import javax.xml.bind.annotation.XmlRootElement;
17 import javax.xml.bind.annotation.XmlElement;
18
19 /**
20  * The class represents the State property of an Edge
21  *
22  *
23  */
24 @XmlRootElement
25 @SuppressWarnings("serial")
26 public class State extends Property {
27     @XmlElement
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     public State clone() {
49         return new State(this.stateValue);
50     }
51
52     public short getValue() {
53         return this.stateValue;
54     }
55
56     @Override
57     public int hashCode() {
58         return HashCodeBuilder.reflectionHashCode(this);
59     }
60
61     @Override
62     public boolean equals(Object obj) {
63         return EqualsBuilder.reflectionEquals(this, obj);
64     }
65
66     @Override
67     public String toString() {
68         return "State[" + ReflectionToStringBuilder.toString(this) + "]";
69     }
70 }