add documentation to the mapping service TELSDN-568: #close

[lispflowmapping.git] / mappingservice / api / src / main / java / org / opendaylight / lispflowmapping / interfaces / dao / IMappingServiceKey.java

diff --git a/mappingservice/api/src/main/java/org/opendaylight/lispflowmapping/interfaces/dao/IMappingServiceKey.java b/mappingservice/api/src/main/java/org/opendaylight/lispflowmapping/interfaces/dao/IMappingServiceKey.java
index 6633e2f9f900a5e5cb23c7b4e617df3984c48784..18510463655fc7c5c23dfba58de5c947502818de 100644 (file)
--- a/mappingservice/api/src/main/java/org/opendaylight/lispflowmapping/interfaces/dao/IMappingServiceKey.java
+++ b/mappingservice/api/src/main/java/org/opendaylight/lispflowmapping/interfaces/dao/IMappingServiceKey.java
@@ -1,15 +1,28 @@
+/*
+ * Copyright (c) 2013 Contextream, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
 package org.opendaylight.lispflowmapping.interfaces.dao;
 
-import org.opendaylight.lispflowmapping.type.lisp.address.LispAddress;
+import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.lispaddress.LispAddressContainer;
 
+/**
+ * The mapping service key in the DAO.
+ */
 public interface IMappingServiceKey {
 
-    LispAddress getEID();
-
-    void setEID(LispAddress eID);
+    /**
+     * @return The eid of the key
+     */
+    LispAddressContainer getEID();
 
+    /**
+     * @return The mask of the eid
+     */
     int getMask();
 
-    void setMask(byte mask);
-
 }