3 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
10 package org.opendaylight.controller.liblldp;
12 import java.util.Arrays;
14 import javax.xml.bind.annotation.XmlAccessType;
15 import javax.xml.bind.annotation.XmlAccessorType;
16 import javax.xml.bind.annotation.XmlElement;
17 import javax.xml.bind.annotation.XmlRootElement;
18 import javax.xml.bind.annotation.XmlTransient;
21 @XmlAccessorType(XmlAccessType.NONE)
22 public class EthernetAddress extends DataLinkAddress {
23 private static final long serialVersionUID = 1L;
25 private byte[] macAddress;
27 public static final EthernetAddress BROADCASTMAC = createWellKnownAddress(new byte[] {
28 (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff,
31 public static final EthernetAddress INVALIDHOST = BROADCASTMAC;
33 public static final String addressName = "Ethernet MAC Address";
34 public static final int SIZE = 6;
36 private static final EthernetAddress createWellKnownAddress(byte[] mac) {
38 return new EthernetAddress(mac);
39 } catch (ConstructionException ce) {
44 /* Private constructor to satisfy JAXB */
45 @SuppressWarnings("unused")
46 private EthernetAddress() {
50 * Public constructor for an Ethernet MAC address starting from
51 * the byte constituing the address, the constructor validate the
52 * size of the arrive to make sure it met the expected size
54 * @param macAddress A byte array in big endian format
55 * representing the Ethernet MAC Address
57 * @return The constructed object if valid
59 public EthernetAddress(byte[] macAddress) throws ConstructionException {
62 if (macAddress == null) {
63 throw new ConstructionException("Null input parameter passed");
66 if (macAddress.length != SIZE) {
67 throw new ConstructionException(
68 "Wrong size of passed byte array, expected:" + SIZE
69 + " got:" + macAddress.length);
71 this.macAddress = new byte[SIZE];
72 System.arraycopy(macAddress, 0, this.macAddress, 0, SIZE);
75 public EthernetAddress clone() {
77 return new EthernetAddress(this.macAddress.clone());
78 } catch (ConstructionException ce) {
84 * Return the Ethernet Mac address in byte array format
86 * @return The Ethernet Mac address in byte array format
88 public byte[] getValue() {
89 return this.macAddress;
93 public int hashCode() {
95 int result = super.hashCode();
96 result = prime * result + Arrays.hashCode(macAddress);
101 public boolean equals(Object obj) {
105 if (!super.equals(obj)) {
108 if (getClass() != obj.getClass()) {
111 EthernetAddress other = (EthernetAddress) obj;
112 if (!Arrays.equals(macAddress, other.macAddress)) {
119 public String toString() {
120 return "EthernetAddress [macAddress=" + HexEncode.bytesToHexStringFormat(macAddress)
124 @XmlElement(name = "macAddress")
125 public String getMacAddress() {
126 return HexEncode.bytesToHexStringFormat(macAddress);