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