tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 1 | package org.onlab.onos.net; |
| 2 | |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 3 | import java.util.Objects; |
| 4 | |
alshabib | 4680bb6 | 2014-09-04 17:15:08 -0700 | [diff] [blame] | 5 | import com.google.common.primitives.UnsignedLongs; |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 6 | |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 7 | /** |
| 8 | * Representation of a port number. |
| 9 | */ |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 10 | public final class PortNumber { |
| 11 | |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 12 | // TODO: revisit the max and the logical port value assignments |
| 13 | |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 14 | private static final long MAX_NUMBER = (2L * Integer.MAX_VALUE) + 1; |
| 15 | |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 16 | public static final PortNumber FLOOD = new PortNumber(-1); |
| 17 | public static final PortNumber IN_PORT = new PortNumber(-2); |
| 18 | public static final PortNumber TABLE = new PortNumber(-3); |
| 19 | public static final PortNumber NORMAL = new PortNumber(-4); |
| 20 | public static final PortNumber ALL = new PortNumber(-4); |
| 21 | public static final PortNumber LOCAL = new PortNumber(-5); |
| 22 | |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 23 | private final long number; |
| 24 | |
| 25 | // Public creation is prohibited |
| 26 | private PortNumber(long number) { |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 27 | this.number = number; |
| 28 | } |
| 29 | |
| 30 | /** |
| 31 | * Returns the port number representing the specified long value. |
| 32 | * |
| 33 | * @param number port number as long value |
| 34 | * @return port number |
| 35 | */ |
| 36 | public static PortNumber portNumber(long number) { |
| 37 | return new PortNumber(number); |
| 38 | } |
| 39 | |
| 40 | /** |
| 41 | * Returns the port number representing the specified string value. |
| 42 | * |
| 43 | * @param string port number as string value |
| 44 | * @return port number |
| 45 | */ |
| 46 | public static PortNumber portNumber(String string) { |
| 47 | return new PortNumber(UnsignedLongs.decode(string)); |
| 48 | } |
| 49 | |
| 50 | /** |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 51 | * Indicates whether or not this port number is a reserved logical one or |
| 52 | * whether it corresponds to a normal physical port of a device or NIC. |
| 53 | * |
| 54 | * @return true if logical port number |
| 55 | */ |
| 56 | public boolean isLogical() { |
| 57 | return number < 0 || number > MAX_NUMBER; |
| 58 | } |
| 59 | |
| 60 | /** |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 61 | * Returns the backing long value. |
| 62 | * |
| 63 | * @return port number as long |
| 64 | */ |
| 65 | public long toLong() { |
| 66 | return number; |
| 67 | } |
| 68 | |
| 69 | @Override |
| 70 | public String toString() { |
| 71 | return UnsignedLongs.toString(number); |
| 72 | } |
| 73 | |
| 74 | @Override |
| 75 | public int hashCode() { |
| 76 | return Objects.hash(number); |
| 77 | } |
| 78 | |
| 79 | @Override |
| 80 | public boolean equals(Object obj) { |
| 81 | if (obj instanceof PortNumber) { |
| 82 | final PortNumber other = (PortNumber) obj; |
| 83 | return this.number == other.number; |
| 84 | } |
| 85 | return false; |
| 86 | } |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 87 | } |