opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/core/Property.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 java.io.Serializable;
  13 import org.apache.commons.lang3.builder.HashCodeBuilder;
  14 import org.apache.commons.lang3.builder.EqualsBuilder;
  15 import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
  16 import javax.xml.bind.annotation.XmlRootElement;
  17 import javax.xml.bind.annotation.XmlSeeAlso;
  18 import javax.xml.bind.annotation.XmlElement;
  19
  20 /**
  21  * @file   Property.java
  22  *
  23  * @brief  Abstract base class for a Property that can be attached to
  24  * any sal core element
  25  *
  26  * Abstract base class for a Property that can be attached to any sal
  27  * core element
  28  */
  29
  30 /**
  31  * Abstract base class for a Property that can be attached to any sal
  32  * core element
  33  *
  34  */
  35 @XmlRootElement
  36 @XmlSeeAlso({ Config.class, Name.class, State.class, TimeStamp.class,
  37                 Latency.class, Bandwidth.class, Tier.class, Actions.class,
  38                 AdvertisedBandwidth.class, Buffers.class, Capabilities.class,
  39                 MacAddress.class, PeerBandwidth.class, SupportedBandwidth.class,
  40                 Tables.class })
  41 abstract public class Property implements Serializable {
  42     private static final long serialVersionUID = 1L;
  43     private String name;
  44
  45     /**
  46      * Private constructor used for JAXB mapping
  47      */
  48     private Property() {
  49         this.name = null;
  50     }
  51
  52     protected Property(String name) {
  53         this.name = name;
  54     }
  55
  56     public String getName() {
  57         return this.name;
  58     }
  59
  60     /**
  61      * Used to copy the Property in a polymorphic way
  62      *
  63      *
  64      * @return A clone of this Property
  65      */
  66     abstract public Property clone();
  67
  68     @Override
  69     public int hashCode() {
  70         return HashCodeBuilder.reflectionHashCode(this);
  71     }
  72
  73     @Override
  74     public boolean equals(Object obj) {
  75         return EqualsBuilder.reflectionEquals(this, obj);
  76     }
  77
  78     @Override
  79     public String toString() {
  80         return "Property[" + ReflectionToStringBuilder.toString(this) + "]";
  81     }
  82 }