Make *Properties.Builder and build immutable Properties object:

    remove {AMQ/}{File/Stream/Test/Tunnel}Properties.java (unused abstracts);
    generate *Properties.Builder with setters and build() methods;
    remove uses of setters on *Properties object (and modify interface);
    adjust tests that set properties to use builders instead.

Author: Steve Powell

codegen.py

@@ -51,12 +51,22 @@ def java_constant_name(c):
     'Date'
     ])
 
-# the types in the range of javaTypeMap must be in java_scala_types
+# the scalar types in the range of javaTypeMap must be in java_scala_types
 java_scalar_types = set([
     'int',
     'long',
     'boolean'
     ])
+javaScalarDefaultMap = {
+    'int': '0',
+    'long': '0L',
+    'boolean': 'false'
+    }
+def java_scalar_default(jtype):
+    if jtype in java_scalar_types:
+        return javaScalarDefaultMap[jtype]
+    else:
+        return 'null'
 
 # the java_scalar_types must be in the domain of javaBoxedTypeMap
 javaBoxedTypeMap = {
@@ -153,6 +163,7 @@ def printHeader():
         printFileHeader()
         print "package com.rabbitmq.client;"
         print
+        print "import java.io.DataInputStream;"
         print "import java.io.IOException;"
         print "import java.util.Collections;"
         print "import java.util.HashMap;"
@@ -195,12 +206,8 @@ def genArgMethods(spec, m):
             for a in m.arguments:
                 (jfType, jfName, jfDefault) = typeNameDefault(spec, a)
 
-                if jfType == "Map<String,Object>":
-                    print "                public Builder %s(%s %s)" % (jfName, jfType, jfName)
-                    print "                {   this.%s = %s==null ? null : Collections.unmodifiableMap(new HashMap<String,Object>(%s)); return this; }" % (jfName, jfName, jfName)
-                else:
-                    print "                public Builder %s(%s %s)" % (jfName, jfType, jfName)
-                    print "                {   this.%s = %s; return this; }" % (jfName, jfName)
+                print "                public Builder %s(%s %s)" % (jfName, jfType, jfName)
+                print "                {   this.%s = %s; return this; }" % (jfName, jfName)
 
                 if jfType == "boolean":
                     print "                public Builder %s()" % (jfName)
@@ -238,27 +245,26 @@ def printClassInterfaces():
                 print "        }"
             print "    }"
 
-    def printReadPropertiesFrom(c):
-        print
-        print "        public void readPropertiesFrom(ContentHeaderPropertyReader reader)"
-        print "            throws IOException"
-        print "        {"
+    def printReadProperties(c):
+        if c.fields:
+            for f in c.fields:
+                (jfName, jfType) = (java_field_name(f.name), java_field_type(spec, f.domain))
+                if jfType in java_scalar_types:
+                    print "            this.%sIsSet = reader.readPresence();" % (jfName)
+                else:
+                    print "            boolean %s_present = reader.readPresence();" % (jfName)
+            print
 
-        for f in c.fields:
-            (jfName, jfType) = (java_field_name(f.name), java_field_type(spec, f.domain))
-            if jfType in java_scalar_types:
-                print "            this.%sIsSet = reader.readPresence();" % (jfName)
-            else:
-                print "            boolean %s_present = reader.readPresence();" % (jfName)
         print "            reader.finishPresence();"
-        for f in c.fields:
-            (jfName, jfType, jfClass) = (java_field_name(f.name), java_field_type(spec, f.domain), java_class_name(f.domain))
-            if jfType in java_scalar_types:
-                print "            if (this.%sIsSet) this.%s = reader.read%s();" % (jfName, jfName, jfClass)
-            else:
-                print "            this.%s = %s_present ? reader.read%s() : null;" % (jfName, jfName, jfClass)
 
-        print "        }"
+        if c.fields:
+            print
+            for f in c.fields:
+                (jfName, jfType, jfClass) = (java_field_name(f.name), java_field_type(spec, f.domain), java_class_name(f.domain))
+                if jfType in java_scalar_types:
+                    print "            if (this.%sIsSet) this.%s = reader.read%s();" % (jfName, jfName, jfClass)
+                else:
+                    print "            this.%s = %s_present ? reader.read%s() : null;" % (jfName, jfName, jfClass)
 
     def printWritePropertiesTo(c):
         print
@@ -298,9 +304,53 @@ def optionalValueClause(jField, jType):
         print "        }"
 
     def printPropertiesBuilderClass(c):
+        def printBuilderSetter(fieldType, fieldName):
+            if fieldType in java_scalar_types:
+                print "            public Builder %s(%s %s)" % (fieldName, fieldType, fieldName)
+                print "            {   this.%s = %s; this.%sIsSet = true; return this; }" % (fieldName, fieldName, fieldName)
+                print "            public Builder %sUnSet() { this.%sIsSet = false; return this; }" % (fieldName, fieldName)
+                if fieldType == "boolean":
+                    print "            public Builder %s()" % (fieldName)
+                    print "            {   return this.%s(true); }" % (fieldName)
+            else:
+                print "            public Builder %s(%s %s)" % (fieldName, fieldType, fieldName)
+                print "            {   this.%s = %s; return this; }" % (fieldName, fieldName)
+                if fieldType == "LongString":
+                    print "            public Builder %s(String %s)" % (fieldName, fieldName)
+                    print "            {   return this.%s(LongStringHelper.asLongString(%s)); }" % (fieldName, fieldName)
+
+        def ctorParm(field):
+            (fType, fName) = (java_field_type(spec, field.domain), java_field_name(field.name))
+            if fType in java_scalar_types:
+                return "%sIsSet ? %s : null" % (fName, fName)
+            else:
+                return fName
+
+        print
         print "        public static final class Builder {"
+        # fields
         for f in c.fields:
-            print "            private %s %s;" % (java_field_type(spec, f.domain),java_field_name(f.name))
+            (fType, fName) = (java_field_type(spec, f.domain), java_field_name(f.name))
+            if fType in java_scalar_types:
+                print "            private boolean %sIsSet = false;" % (fName)
+            print "            private %s %s;" % (fType, fName)
+        # ctor
+        print
+        print "            public Builder() {};"
+        # setters
+        print
+        for f in c.fields:
+            printBuilderSetter(java_field_type(spec, f.domain), java_field_name(f.name))
+        print
+        jClassName = java_class_name(c.name)
+        # build()
+        objName = "%sProperties" % (jClassName)
+        ctor_parm_list = [ ctorParm(f) for f in c.fields ]
+        print "            public %s build() {" % (objName)
+        print "                return new %s" % (objName)
+        print "                    ( %s" % ("\n                    , ".join(ctor_parm_list))
+        print "                    );"
+        print "            }"
 
         print "        }"
 
@@ -309,42 +359,51 @@ def printGetterAndSetter(fieldType, fieldName):
             capFieldName = fieldName[0].upper() + fieldName[1:]
             print "        public %s get%s() { return this.%s; }" % (fieldType, capFieldName, fieldName)
             if fieldType in java_scalar_types:
-                print "        public void set%s(%s %s)" % (capFieldName, fieldType, fieldName) 
-                print "        { this.%s = %s; this.%sIsSet = true; }" % (fieldName, fieldName, fieldName) 
+                print "        public void set%s(%s %s)" % (capFieldName, fieldType, fieldName)
+                print "        {   this.%s = %s; this.%sIsSet = true; }" % (fieldName, fieldName, fieldName)
             else:
-                print "        public void set%s(%s %s) { this.%s = %s; }" % (capFieldName, fieldType, fieldName, fieldName, fieldName) 
+                print "        public void set%s(%s %s) { this.%s = %s; }" % (capFieldName, fieldType, fieldName, fieldName, fieldName)
 
         jClassName = java_class_name(c.name)
 
         print
         print "    public static class %sProperties extends com.rabbitmq.client.impl.AMQ%sProperties {" % (jClassName, jClassName)
         #property fields
         for f in c.fields:
-            (fType, fName) = (java_field_type(spec, f.domain),java_field_name(f.name))
+            (fType, fName) = (java_field_type(spec, f.domain), java_field_name(f.name))
             if fType in java_scalar_types:
                 print "        private boolean %sIsSet = false;" % (fName)
             print "        private %s %s;" % (fType, fName)
 
         #explicit constructor
         if c.fields:
             print
-            consParmList = [ "%s %s" % (java_boxed_type(java_field_type(spec,f.domain)),java_field_name(f.name))
+            consParmList = [ "%s %s" % (java_boxed_type(java_field_type(spec,f.domain)), java_field_name(f.name))
                              for f in c.fields ]
             print "        public %sProperties(" % (jClassName)
             print "            %s)" % (",\n            ".join(consParmList))
             print "        {"
             for f in c.fields:
-                (fType, fName) = (java_field_type(spec, f.domain),java_field_name(f.name))
+                (fType, fName) = (java_field_type(spec, f.domain), java_field_name(f.name))
                 if fType in java_scalar_types:
-                    print "            if (%s == null) { this.%sIsSet = false; }" % (fName, fName)
+                    print "            if (%s == null) { this.%sIsSet = false; this.%s = %s; }" % (fName, fName, fName, java_scalar_default(fType))
                     print "            else { this.%sIsSet = true; this.%s = %s; }" % (fName, fName, fName)
                 else:
-                    print "            this.%s = %s;" % (fName, fName)
+                    if fType == "Map<String,Object>":
+                        print "            this.%s = %s==null ? null : Collections.unmodifiableMap(new HashMap<String,Object>(%s));" % (fName, fName, fName)
+                    else:
+                        print "            this.%s = %s;" % (fName, fName)
             print "        }"
 
-        #default constructor
+        #datainputstream constructor
         print
-        print "        public %sProperties() {}" % (jClassName)
+        print "        public %sProperties(DataInputStream in) throws IOException {" % (jClassName)
+        print "            super(in);"
+        print "            ContentHeaderPropertyReader reader = new ContentHeaderPropertyReader(in);"
+        
+        printReadProperties(c)
+        
+        print "        }"
 
         #class properties
         print "        public int getClassId() { return %i; }" % (c.index)
@@ -355,7 +414,6 @@ def printGetterAndSetter(fieldType, fieldName):
         for f in c.fields:
             printGetterAndSetter(java_field_type(spec, f.domain), java_field_name(f.name))
 
-        printReadPropertiesFrom(c)
         printWritePropertiesTo(c)
         printAppendArgumentDebugStringTo(c)
         printPropertiesBuilderClass(c)
@@ -387,6 +445,8 @@ def printHeader():
         print
         print "import java.io.IOException;"
         print "import java.io.DataInputStream;"
+        print "import java.util.Collections;"
+        print "import java.util.HashMap;"
         print "import java.util.Map;"
         print
         print "import com.rabbitmq.client.AMQP;"
@@ -413,11 +473,16 @@ def constructors():
                 fieldsToNullCheckInCons = nullCheckedFields(spec, m)
 
                 for f in fieldsToNullCheckInCons:
-                    print "                if(%s == null)" % (f)
+                    print "                if (%s == null)" % (f)
                     print "                    throw new IllegalStateException(\"Invalid configuration: '%s' must be non-null.\");" % (f)
 
                 for a in m.arguments:
-                    print "                this.%s = %s;" % (java_field_name(a.name), java_field_name(a.name))
+                    (jfType, jfName) = (java_field_type(spec, a.domain), java_field_name(a.name))
+                    if jfType == "Map<String,Object>":
+                        print "                this.%s = %s==null ? null : Collections.unmodifiableMap(new HashMap<String,Object>(%s));" % (jfName, jfName, jfName)
+                    else:
+                        print "                this.%s = %s;" % (jfName, jfName)
+
                 print "            }"
 
                 consArgs = [ "rdr.read%s()" % (java_class_name(spec.resolveDomain(a.domain))) for a in m.arguments ]
@@ -525,11 +590,11 @@ def printContentHeaderReader():
         print "        switch (classId) {"
         for c in spec.allClasses():
             if c.fields:
-                print "            case %s: return new %sProperties();" %(c.index, (java_class_name(c.name)))
+                print "            case %s: return new %sProperties(in);" %(c.index, (java_class_name(c.name)))
         print "            default: break;"
         print "        }"
         print
-        print "        throw new UnknownClassOrMethodId(classId, -1);"
+        print "        throw new UnknownClassOrMethodId(classId);"
         print "    }"
 
     printHeader()

src/com/rabbitmq/client/BasicProperties.java

@@ -100,82 +100,5 @@ public interface BasicProperties {
      */
     public abstract String getAppId();
 
-    /**
-     * Set the contentType field, or null indicating the field is not set
-     * @param contentType the value to set the field to
-     */
-    public abstract void setContentType(String contentType);
-    
-    /**
-     * Set the contentEncoding field, or null indicating the field is not set
-     * @param contentEncoding - the value to set the field to
-     */
-    public abstract void setContentEncoding(String contentEncoding);
-    
-    /**
-     * Set the headers table, or null indicating the field is not set
-     * @param headers a map of table field names and values
-     */
-    public abstract void setHeaders(Map<String, Object> headers);
-    
-    /**
-     * Set the deliveryMode field, or null indicating the field is not set
-     * @param deliveryMode the value to set the field to
-     */
-    public abstract void setDeliveryMode(int deliveryMode);
-    
-    /**
-     * Set the priority field, or null indicating the field is not set
-     * @param priority the value to set the field to
-     */
-    public abstract void setPriority(int priority);
-    
-    /**
-     * Set the correlationId field, or null indicating the field is not set
-     * @param correlationId the value to set the field to
-     */
-    public abstract void setCorrelationId(String correlationId);
-    
-    /**
-     * Set the replyTo field, or null indicating the field is not set
-     * @param replyTo the value to set the field to
-     */
-    public abstract void setReplyTo(String replyTo);
-    
-    /**
-     * Set the expiration field, or null indicating the field is not set
-     * @param expiration the value to set the field to
-     */
-    public abstract void setExpiration(String expiration);
-    
-    /**
-     * Set the messageId field, or null indicating the field is not set
-     * @param messageId the value to set the field to
-     */
-    public abstract void setMessageId(String messageId);
-    
-    /**
-     * Set the timestamp field, or null indicating the field is not set
-     * @param timestamp the value to set the field to
-     */
-    public abstract void setTimestamp(Date timestamp);
-    
-    /**
-     * Set the type field, or null indicating the field is not set
-     * @param type the value to set the field to
-     */
-    public abstract void setType(String type);
-    
-    /**
-     * Set the userId field, or null indicating the field is not set
-     * @param userId the value to set the field to
-     */
-    public abstract void setUserId(String userId);
-    
-    /**
-     * Set the appId field, or null indicating the field is not set
-     * @param appId the value to set the field to
-     */
-    public abstract void setAppId(String appId);
-    
+
 }