Merge pull request dropbox#260 from avf/master

Added command line option for specifying the access modifier for generated java classes
ISBX · Aug 9, 2016 · e6a54da · e6a54da
2 parents fd141ea + b1a71fd
commit e6a54da
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 8 deletions.
diff --git a/example/generated-src/java/com/dropbox/textsort/ItemList.java b/example/generated-src/java/com/dropbox/textsort/ItemList.java
@@ -7,7 +7,7 @@
 import javax.annotation.CheckForNull;
 import javax.annotation.Nonnull;
 
-public final class ItemList {
+/*package*/ final class ItemList {
 
 
     /*package*/ final ArrayList<String> mItems;

diff --git a/example/generated-src/java/com/dropbox/textsort/SortItems.java b/example/generated-src/java/com/dropbox/textsort/SortItems.java
@@ -7,7 +7,7 @@
 import javax.annotation.CheckForNull;
 import javax.annotation.Nonnull;
 
-public abstract class SortItems {
+/*package*/ abstract class SortItems {
     /** For the iOS / Android demo */
     public abstract void sort(@Nonnull SortOrder order, @Nonnull ItemList items);
 

diff --git a/example/generated-src/java/com/dropbox/textsort/SortOrder.java b/example/generated-src/java/com/dropbox/textsort/SortOrder.java
@@ -6,7 +6,7 @@
 import javax.annotation.CheckForNull;
 import javax.annotation.Nonnull;
 
-public enum SortOrder {
+/*package*/ enum SortOrder {
     ASCENDING,
     DESCENDING,
     RANDOM,

diff --git a/example/generated-src/java/com/dropbox/textsort/TextboxListener.java b/example/generated-src/java/com/dropbox/textsort/TextboxListener.java
@@ -6,6 +6,6 @@
 import javax.annotation.CheckForNull;
 import javax.annotation.Nonnull;
 
-public abstract class TextboxListener {
+/*package*/ abstract class TextboxListener {
     public abstract void update(@Nonnull ItemList items);
 }
diff --git a/example/run_djinni.sh b/example/run_djinni.sh
@@ -53,6 +53,7 @@ fi
 "$base_dir/../src/run-assume-built" \
     --java-out "$temp_out/java" \
     --java-package $java_package \
+    --java-class-access-modifier "package" \
     --java-nullable-annotation "javax.annotation.CheckForNull" \
     --java-nonnull-annotation "javax.annotation.Nonnull" \
     --ident-java-field mFooBar \

diff --git a/src/source/JavaGenerator.scala b/src/source/JavaGenerator.scala
@@ -29,6 +29,7 @@ class JavaGenerator(spec: Spec) extends Generator(spec) {
   val javaAnnotationHeader = spec.javaAnnotation.map(pkg => '@' + pkg.split("\\.").last)
   val javaNullableAnnotation = spec.javaNullableAnnotation.map(pkg => '@' + pkg.split("\\.").last)
   val javaNonnullAnnotation = spec.javaNonnullAnnotation.map(pkg => '@' + pkg.split("\\.").last)
+  val javaClassAccessModifierString = JavaAccessModifier.getCodeGenerationString(spec.javaClassAccessModifier)
   val marshal = new JavaMarshal(spec)
 
   class JavaRefs() {
@@ -109,7 +110,7 @@ class JavaGenerator(spec: Spec) extends Generator(spec) {
     writeJavaFile(ident, origin, refs.java, w => {
       writeDoc(w, doc)
       javaAnnotationHeader.foreach(w.wl)
-      w.w(s"public enum ${marshal.typename(ident, e)}").braced {
+      w.w(s"${javaClassAccessModifierString}enum ${marshal.typename(ident, e)}").braced {
         for (o <- e.options) {
           writeDoc(w, o.doc)
           w.wl(idJava.enum(o.ident) + ",")
@@ -139,7 +140,7 @@ class JavaGenerator(spec: Spec) extends Generator(spec) {
       writeDoc(w, doc)
 
       javaAnnotationHeader.foreach(w.wl)
-      w.w(s"public abstract class $javaClass$typeParamList").braced {
+      w.w(s"${javaClassAccessModifierString}abstract class $javaClass$typeParamList").braced {
         val skipFirst = SkipFirst()
         generateJavaConstants(w, i.consts)
 
@@ -212,7 +213,7 @@ class JavaGenerator(spec: Spec) extends Generator(spec) {
     r.fields.foreach(f => refs.find(f.ty))
 
     val javaName = if (r.ext.java) (ident.name + "_base") else ident.name
-    val javaFinal = if (!r.ext.java && spec.javaUseFinalForRecord) " final" else ""
+    val javaFinal = if (!r.ext.java && spec.javaUseFinalForRecord) "final " else ""
 
     writeJavaFile(javaName, origin, refs.java, w => {
       writeDoc(w, doc)
@@ -225,7 +226,7 @@ class JavaGenerator(spec: Spec) extends Generator(spec) {
         } else {
           ""
         }
-      w.w(s"public$javaFinal class ${self + javaTypeParams(params)}$comparableFlag").braced {
+      w.w(s"${javaClassAccessModifierString}${javaFinal}class ${self + javaTypeParams(params)}$comparableFlag").braced {
         w.wl
         generateJavaConstants(w, r.consts)
         // Field definitions.

diff --git a/src/source/Main.scala b/src/source/Main.scala
@@ -38,6 +38,7 @@ object Main {
     var cppUseWideStrings: Boolean = false
     var javaOutFolder: Option[File] = None
     var javaPackage: Option[String] = None
+    var javaClassAccessModifier: JavaAccessModifier.Value = JavaAccessModifier.Public
     var javaCppException: Option[String] = None
     var javaAnnotation: Option[String] = None
     var javaNullableAnnotation: Option[String] = None
@@ -99,6 +100,8 @@ object Main {
         .text("The output for the Java files (Generator disabled if unspecified).")
       opt[String]("java-package").valueName("...").foreach(x => javaPackage = Some(x))
         .text("The package name to use for generated Java classes.")
+      opt[JavaAccessModifier.Value]("java-class-access-modifier").valueName("<public/package>").foreach(x => javaClassAccessModifier = x)
+        .text("The access modifier to use for generated Java classes (default: public).")
       opt[String]("java-cpp-exception").valueName("<exception-class>").foreach(x => javaCppException = Some(x))
         .text("The type for translated C++ exceptions in Java (default: java.lang.RuntimeException that is not checked)")
       opt[String]("java-annotation").valueName("<annotation-class>").foreach(x => javaAnnotation = Some(x))
@@ -277,6 +280,7 @@ object Main {
     val outSpec = Spec(
       javaOutFolder,
       javaPackage,
+      javaClassAccessModifier,
       javaIdentStyle,
       javaCppException,
       javaAnnotation,

diff --git a/src/source/generator.scala b/src/source/generator.scala
@@ -30,6 +30,7 @@ package object generatorTools {
   case class Spec(
                    javaOutFolder: Option[File],
                    javaPackage: Option[String],
+                   javaClassAccessModifier: JavaAccessModifier.Value,
                    javaIdentStyle: JavaIdentStyle,
                    javaCppException: Option[String],
                    javaAnnotation: Option[String],
@@ -138,6 +139,20 @@ package object generatorTools {
     }
   }
 
+  object JavaAccessModifier extends Enumeration {
+    val Public = Value("public")
+    val Package = Value("package")
+
+    def getCodeGenerationString(javaAccessModifier: JavaAccessModifier.Value): String = {
+      javaAccessModifier match {
+        case Public => "public "
+        case Package => "/*package*/ "
+      }
+    }
+
+  }
+  implicit val javaAccessModifierReads: scopt.Read[JavaAccessModifier.Value] = scopt.Read.reads(JavaAccessModifier withName _)
+
   final case class SkipFirst() {
     private var first = true