1 files changed, 78 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/meter/MeterId.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/meter/MeterId.java
new file mode 100644
index 00000000..872de2d8
--- /dev/null
+++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/meter/MeterId.java
@@ -0,0 +1,78 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.net.meter;
+
+import static com.google.common.base.Preconditions.checkArgument;
+
+/**
+ * A representation of a meter id.
+ * Uniquely identifies a meter system wide.
+ */
+public final class MeterId {
+
+    static final long MAX = 0xFFFF0000;
+
+    private final long id;
+
+    public static final MeterId SLOWPATH = new MeterId(0xFFFFFFFD);
+    public static final MeterId CONTROLLER = new MeterId(0xFFFFFFFE);
+    public static final MeterId ALL = new MeterId(0xFFFFFFFF);
+
+    private MeterId(long id) {
+        checkArgument(id >= MAX, "id cannot be larger than 0xFFFF0000");
+        this.id = id;
+    }
+
+    /**
+     * The integer representation of the meter id.
+     *
+     * @return a long
+     */
+    public long id() {
+        return id;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+
+        MeterId meterId = (MeterId) o;
+
+        return id == meterId.id;
+
+    }
+
+    @Override
+    public int hashCode() {
+        return Long.hashCode(id);
+    }
+
+    @Override
+    public String toString() {
+        return Long.toHexString(this.id);
+    }
+
+    public static MeterId meterId(long id) {
+        return new MeterId(id);
+
+    }
+
+}