Javadoc for the SDN-IP module
Change-Id: If656aa20ccc76e500364fcb88d8c79339f2ff144
diff --git a/src/main/java/net/onrc/onos/apps/bgproute/BgpPeer.java b/src/main/java/net/onrc/onos/apps/bgproute/BgpPeer.java
index d103918..a535316 100644
--- a/src/main/java/net/onrc/onos/apps/bgproute/BgpPeer.java
+++ b/src/main/java/net/onrc/onos/apps/bgproute/BgpPeer.java
@@ -6,20 +6,41 @@
import com.google.common.net.InetAddresses;
+/**
+ * Configuration details for a BGP peer. It contains the peer's IP address and
+ * an interface name which maps to the interface they are attached at.
+ */
public class BgpPeer {
private final String interfaceName;
private final InetAddress ipAddress;
+ /**
+ * Class constructor, taking the interface name and IP address of the peer.
+ *
+ * @param interfaceName the String name of the interface which can be used
+ * to look up the interface this peer is attached at
+ * @param ipAddress the IP address of the peer as a String
+ */
public BgpPeer(@JsonProperty("interface") String interfaceName,
@JsonProperty("ipAddress") String ipAddress) {
this.interfaceName = interfaceName;
this.ipAddress = InetAddresses.forString(ipAddress);
}
+ /**
+ * Gets the interface name.
+ *
+ * @return the interface name as a String
+ */
public String getInterfaceName() {
return interfaceName;
}
+ /**
+ * Gets the IP address of the peer.
+ *
+ * @return the IP address as an {@link InetAddress} object
+ */
public InetAddress getIpAddress() {
return ipAddress;
}