Make Java WirelessRegulatoryConfig class immutable

Author: Jay Logue

src/device-manager/java/WeaveDeviceManager-JNI.cpp

@@ -3519,7 +3519,7 @@ WEAVE_ERROR J2N_WirelessRegulatoryConfig(JNIEnv *env, jobject inRegConfig, Wirel
         memcpy(outRegConfig.RegDomain.Code, strVal, sizeof(outRegConfig.RegDomain.Code));
     }
 
-    err = J2N_EnumFieldVal(env, inRegConfig, "OpLocation", "Lnl/Weave/DeviceManager/OperatingLocation;", enumVal);
+    err = J2N_EnumFieldVal(env, inRegConfig, "OpLocation", "Lnl/Weave/DeviceManager/WirelessOperatingLocation;", enumVal);
     SuccessOrExit(err);
     outRegConfig.OpLocation = (uint8_t)enumVal;
 
@@ -3536,7 +3536,7 @@ WEAVE_ERROR J2N_WirelessRegulatoryConfig(JNIEnv *env, jobject inRegConfig, Wirel
 WEAVE_ERROR N2J_WirelessRegulatoryConfig(JNIEnv *env, const WirelessRegConfig& inRegConfig, jobject& outRegConfig)
 {
     WEAVE_ERROR err = WEAVE_NO_ERROR;
-    jmethodID makeMethod;
+    jmethodID constructor;
     jstring regDomain = NULL;
     jobjectArray supportedRegDomains = NULL;
     jclass java_lang_String = NULL;
@@ -3560,11 +3560,11 @@ WEAVE_ERROR N2J_WirelessRegulatoryConfig(JNIEnv *env, const WirelessRegConfig& i
         });
     SuccessOrExit(err);
 
-    makeMethod = env->GetStaticMethodID(sWirelessRegulatoryConfigCls, "Make", "(Ljava/lang/String;I[Ljava/lang/String;)Lnl/Weave/DeviceManager/WirelessRegulatoryConfig;");
-    VerifyOrExit(makeMethod != NULL, err = WDM_JNI_ERROR_METHOD_NOT_FOUND);
+    constructor = env->GetMethodID(sWirelessRegulatoryConfigCls, "<init>", "(Ljava/lang/String;I[Ljava/lang/String;)V");
+    VerifyOrExit(constructor != NULL, err = WDM_JNI_ERROR_METHOD_NOT_FOUND);
 
     env->ExceptionClear();
-    outRegConfig = env->CallStaticObjectMethod(sWirelessRegulatoryConfigCls, makeMethod,
+    outRegConfig = (jthrowable)env->NewObject(sWirelessRegulatoryConfigCls, constructor,
             regDomain, (jint)inRegConfig.OpLocation, supportedRegDomains);
     VerifyOrExit(!env->ExceptionCheck(), err = WDM_JNI_ERROR_EXCEPTION_THROWN);
 

src/device-manager/java/src/nl/Weave/DeviceManager/TestMain.java

@@ -834,7 +834,7 @@ void RunUnitTests()
         TestResult = null;
         System.out.println("SetWirelessRegulatoryConfig Test");
         System.out.println("    Setting wireless regulatory configuration...");
-        WirelessRegulatoryConfig regConfig = WirelessRegulatoryConfig.Make("CA", WirelessOperatingLocation.Indoors.val, null);
+        WirelessRegulatoryConfig regConfig = new WirelessRegulatoryConfig("CA", WirelessOperatingLocation.Indoors);
         DeviceMgr.beginSetWirelessRegulatoryConfig(regConfig);
         ExpectSuccess("SetWirelessRegulatoryConfig");
         System.out.println("SetWirelessRegulatoryConfig Test Succeeded");

src/device-manager/java/src/nl/Weave/DeviceManager/WirelessRegulatoryConfig.java

@@ -21,33 +21,39 @@
 /**
  * Container for wireless regulatory configuration information.
  */
-public class WirelessRegulatoryConfig
+public final class WirelessRegulatoryConfig
 {
     /** Active wireless regulatory domain.
      */
-    public String RegDomain;
+    public final String RegDomain;
 
     /** Active operating location.
      */
-    public WirelessOperatingLocation OpLocation;
+    public final WirelessOperatingLocation OpLocation;
 
     /** Supported regulatory domains
      */
-    public String[] SupportedRegDomains;
+    public final String[] SupportedRegDomains;
 
-    public WirelessRegulatoryConfig()
+    public WirelessRegulatoryConfig(String regDomain, WirelessOperatingLocation opLocation)
     {
-        RegDomain = null;
-        OpLocation = WirelessOperatingLocation.NotSpecified;
-        SupportedRegDomains = null;
+		this.RegDomain = regDomain;
+		this.OpLocation = opLocation;
+		this.SupportedRegDomains = new String[0];
+    }
+
+    public WirelessRegulatoryConfig(String regDomain, WirelessOperatingLocation opLocation, String[] supportedRegDomains)
+    {
+        this.RegDomain = regDomain;
+        this.OpLocation = opLocation;
+        this.SupportedRegDomains = supportedRegDomains.clone();
     }
 
-    public static WirelessRegulatoryConfig Make(String regDomain, int opLocation, String[] supportedRegDomains)
+    // Convenience constructor for JNI code
+    WirelessRegulatoryConfig(String regDomain, int opLocation, String[] supportedRegDomains)
     {
-        WirelessRegulatoryConfig regConfig = new WirelessRegulatoryConfig();
-        regConfig.RegDomain = regDomain;
-        regConfig.OpLocation = WirelessOperatingLocation.fromVal(opLocation);
-        regConfig.SupportedRegDomains = supportedRegDomains;
-        return regConfig;
+        this.RegDomain = regDomain;
+        this.OpLocation = WirelessOperatingLocation.fromVal(opLocation);
+        this.SupportedRegDomains = supportedRegDomains;
     }
 };