opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/core/PeerBandwidth.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.XmlRootElement;
  15
  16 /**
  17  * @file   PeerBandWidth.java
  18  *
  19  * @brief  Class representing peer bandwidth
  20  *
  21  * Describes peer Bandwidth of peer element. It's intended in multiple of
  22  *  bits per seconds.
  23  */
  24 @XmlRootElement
  25 @XmlAccessorType(XmlAccessType.NONE)
  26 public class PeerBandwidth extends Bandwidth {
  27         private static final long serialVersionUID = 1L;
  28
  29         public static final String PeerBandwidthPropName = "peerBandwidth";
  30
  31         public PeerBandwidth(long value) {
  32                 super(PeerBandwidthPropName);
  33                 this.bandwidthValue = value;
  34         }
  35
  36         /*
  37      * Private constructor used for JAXB mapping
  38      */
  39     private PeerBandwidth() {
  40         super(PeerBandwidthPropName);
  41                 this.bandwidthValue = 0;
  42     }
  43
  44         public PeerBandwidth clone() {
  45                 return new PeerBandwidth(this.bandwidthValue);
  46     }
  47
  48
  49     @Override
  50     public String toString() {
  51         StringBuffer sb = new StringBuffer();
  52         sb.append("PeerBandWidth[");
  53         sb.append(super.toString());
  54         sb.append("]");
  55         return sb.toString();
  56     }
  57 }