Merge pull request #42 from stealthcopter/feature/develop

Feature/develop

Author: stealthcopter

.circleci/key.p12.enc

@@ -10,3 +10,4 @@
 /captures
 TODO
 key.p12
+/keystore

.gitignore

@@ -32,8 +32,8 @@ android {
     applicationId "com.stealthcotper.networktools"
     minSdkVersion minSdkVer
     targetSdkVersion targetSdkVer
-    versionCode versionName
-    versionName versionCode
+    versionName appVersionName
+    versionCode appVersionCode
     archivesBaseName = "AndroidNetworkTools"
     testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
   }

app/build.gradle

@@ -30,6 +30,6 @@ subprojects {
   ext.targetSdkVer = 27
   ext.supportLibVer = "27.1.1"
 
-  ext.versionName = "0.4.0"
-  ext.versionCode = 14
+  ext.appVersionName = "0.4.0"
+  ext.appVersionCode = 14
 }

build.gradle

@@ -8,5 +8,20 @@ dependencies {
   testImplementation 'org.mockito:mockito-core:2.10.0'
 }
 
+task sourcesJar(type: Jar, dependsOn: classes) {
+    classifier = 'sources'
+    from sourceSets.main.allSource
+}
+
+task javadocJar(type: Jar) {
+    classifier = 'javadoc'
+    from javadoc
+}
+
+artifacts {
+    archives sourcesJar
+    archives javadocJar
+}
+
 sourceCompatibility = "1.7"
 targetCompatibility = "1.7"

library/build.gradle

@@ -8,10 +8,10 @@
 
 /**
  * Created by mat on 09/12/15.
- * <p/>
+ *
  * Looks at the file at /proc/net/arp to fromIPAddress ip/mac addresses from the cache
  * We assume that the file has this structure:
- * <p/>
+ *
  * IP address       HW type     Flags       HW address            Mask     Device
  * 192.168.18.11    0x1         0x2         00:04:20:06:55:1a     *        eth0
  * 192.168.18.36    0x1         0x2         00:22:43:ab:2a:5b     *        eth0

library/src/main/java/com/stealthcopter/networktools/ARPInfo.java

@@ -154,6 +154,7 @@ public void cancel() {
      * request
      *
      * @return - ping result
+     * @throws UnknownHostException - if the host cannot be resolved
      */
     public PingResult doPing() throws UnknownHostException {
         cancelled = false;

library/src/main/java/com/stealthcopter/networktools/Ping.java

@@ -54,7 +54,7 @@ public interface PortListener {
      * @param address - Address to be pinged
      * @return this object to allow chaining
      * @throws UnknownHostException - if no IP address for the
-     *                              <code>host</code> could be found, or if a scope_id was specified
+     *                              {@code host} could be found, or if a scope_id was specified
      *                              for a global IPv6 address.
      */
     public static PortScan onAddress(String address) throws UnknownHostException {

library/src/main/java/com/stealthcopter/networktools/PortScan.java

@@ -34,6 +34,8 @@ public interface OnSubnetDeviceFound {
 
     /**
      * Find devices on the subnet working from the local device ip address
+     *
+     * @return - this for chaining
      */
     public static SubnetDevices fromLocalAddress() {
         InetAddress ipv4 = IPTools.getLocalIPv4Address();
@@ -47,6 +49,8 @@ public static SubnetDevices fromLocalAddress() {
 
     /**
      * @param inetAddress - an ip address in the subnet
+     *
+     * @return - this for chaining
      */
     public static SubnetDevices fromIPAddress(InetAddress inetAddress) {
         return fromIPAddress(inetAddress.getHostAddress());
@@ -55,6 +59,8 @@ public static SubnetDevices fromIPAddress(InetAddress inetAddress) {
     /**
      * @param ipAddress - the ipAddress string of any device in the subnet i.e. "192.168.0.1"
      *                  the final part will be ignored
+     *
+     * @return - this for chaining
      */
     public static SubnetDevices fromIPAddress(final String ipAddress) {
 
@@ -84,6 +90,8 @@ public static SubnetDevices fromIPAddress(final String ipAddress) {
 
     /**
      * @param ipAddresses - the ipAddresses of devices to be checked
+     *
+     * @return - this for chaining
      */
     public static SubnetDevices fromIPList(final List<String> ipAddresses) {
 
@@ -100,8 +108,10 @@ public static SubnetDevices fromIPList(final List<String> ipAddresses) {
     /**
      * @param noThreads set the number of threads to work with, note we default to a large number
      *                  as these requests are network heavy not cpu heavy.
-     * @return self
-     * @throws IllegalAccessException
+     *
+     * @throws IllegalArgumentException - if invalid number of threads requested
+     *
+     * @return - this for chaining
      */
     public SubnetDevices setNoThreads(int noThreads) throws IllegalArgumentException {
         if (noThreads < 1) throw new IllegalArgumentException("Cannot have less than 1 thread");
@@ -112,9 +122,13 @@ public SubnetDevices setNoThreads(int noThreads) throws IllegalArgumentException
     /**
      * Sets the timeout for each address we try to ping
      *
+     * @param timeOutMillis - timeout in milliseconds for each ping
+     *
      * @return this object to allow chaining
+     *
+     * @throws IllegalArgumentException - if timeout is less than zero
      */
-    public SubnetDevices setTimeOutMillis(int timeOutMillis) {
+    public SubnetDevices setTimeOutMillis(int timeOutMillis) throws IllegalArgumentException {
         if (timeOutMillis < 0) throw new IllegalArgumentException("Timeout cannot be less than 0");
         this.timeOutMillis = timeOutMillis;
         return this;

library/src/main/java/com/stealthcopter/networktools/SubnetDevices.java

@@ -141,6 +141,8 @@ public void wake() throws IOException {
     /**
      * Asynchronous call of the wake method. This will be performed on the background thread
      * and optionally fire a listener when complete, or when an error occurs
+     *
+     * @param wakeOnLanListener - listener to call on result
      */
     public void wake(final WakeOnLanListener wakeOnLanListener) {
 
@@ -165,6 +167,9 @@ public void run() {
      *
      * @param ipStr  - IP String to send to
      * @param macStr - MAC address to wake up
+     *
+     * @throws IllegalArgumentException - invalid ip or mac
+     * @throws IOException - error sending packet
      */
     public static void sendWakeOnLan(String ipStr, String macStr) throws IllegalArgumentException, IOException {
         sendWakeOnLan(ipStr, macStr, DEFAULT_PORT, DEFAULT_TIMEOUT_MILLIS, DEFAULT_NO_PACKETS);
@@ -178,6 +183,9 @@ public static void sendWakeOnLan(String ipStr, String macStr) throws IllegalArgu
      * @param port          - port to send packet to
      * @param timeoutMillis - timeout (millis)
      * @param packets       - number of packets to send
+     *
+     * @throws IllegalArgumentException - invalid ip or mac
+     * @throws IOException - error sending packet
      */
     public static void sendWakeOnLan(final String ipStr, final String macStr, final int port, final int timeoutMillis, final int packets) throws IllegalArgumentException, IOException {
         if (ipStr == null) throw new IllegalArgumentException("Address cannot be null");
@@ -193,6 +201,9 @@ public static void sendWakeOnLan(final String ipStr, final String macStr, final
      * @param port          - port to send packet to
      * @param timeoutMillis - timeout (millis)
      * @param packets       - number of packets to send
+     *
+     * @throws IllegalArgumentException - invalid ip or mac
+     * @throws IOException - error sending packet
      */
     public static void sendWakeOnLan(final InetAddress address, final String macStr, final int port, final int timeoutMillis, final int packets) throws IllegalArgumentException, IOException {
         if (address == null) throw new IllegalArgumentException("Address cannot be null");