review changes

Author: Pritham Marupaka

conjure-java-core/src/main/java/com/palantir/conjure/java/Options.java

@@ -188,9 +188,14 @@ default boolean preferObjectBuilders() {
     }
 
     /**
+     * Warning: this is an experimental feature.
+     * <p>
      * If enabled, endpoints that have associated errors will return a result type: a sealed interface permitting
      * subclasses for the endpoint's return value, and each endpoint error. Each endpoint error is a subclass of
      * {@link com.palantir.dialogue.EndpointError}.
+     *<p>
+     * Producing JARs with this feature enabled will result in a compile-time break when consumers bump their dependency
+     * on the JAR. This is because the return types of every endpoint with associated errors will change.
      */
     @Value.Default
     default boolean generateDialogueEndpointErrorResultTypes() {

conjure-java-core/src/main/java/com/palantir/conjure/java/services/dialogue/DialogueServiceGenerator.java

@@ -106,7 +106,7 @@ private static Stream<JavaFile> generateFilesForService(
             DialogueInterfaceGenerator interfaceGenerator,
             StaticFactoryMethodGenerator blockingGenerator,
             StaticFactoryMethodGenerator asyncGenerator) {
-        List<JavaFile> files = new ArrayList<>(/* initialCapacity= */ 4);
+        List<JavaFile> files = new ArrayList<>(/* initialCapacity= */ 3);
         if (!serviceDef.getEndpoints().isEmpty()) {
             files.add(endpointsGenerator.endpointsClass(serviceDef));
         }

conjure-java-core/src/main/java/com/palantir/conjure/java/services/dialogue/ReturnTypeMapper.java

@@ -47,15 +47,15 @@ public TypeName async(Optional<Type> type) {
         return ParameterizedTypeName.get(LISTENABLE_FUTURE, Primitives.box(baseType(type)));
     }
 
-    public boolean isBinaryOrOptionalBinary(TypeName returnType) {
+    boolean isBinaryOrOptionalBinary(TypeName returnType) {
         return isBinary(returnType) || isOptionalBinary(returnType);
     }
 
-    public boolean isOptionalBinary(TypeName returnType) {
+    boolean isOptionalBinary(TypeName returnType) {
         return returnType.equals(baseType(Type.optional(OptionalType.of(Type.primitive(PrimitiveType.BINARY)))));
     }
 
-    public boolean isBinary(TypeName returnType) {
+    boolean isBinary(TypeName returnType) {
         return returnType.equals(baseType(Type.primitive(PrimitiveType.BINARY)));
     }
 }

readme.md

@@ -51,8 +51,12 @@ The recommended way to use conjure-java is via a build tool like [gradle-conjure
         --preferObjectBuilders
                      Exclude static factory methods from generated objects with one or more fields. Note that for 
                      objects without any fields, this will still generate the static factory method.
-	--generateDialogueEndpointErrorResultTypes
-		     For endpoints with errors associated with them, generate methods which return result types in Dialogue clients
+        --generateDialogueEndpointErrorResultTypes
+                     This is an experimental feature. If enabled, endpoints that have associated errors will return a 
+                     result type: a sealed interface permitting subclasses for the endpoint's return value, and each 
+                     endpoint error. Producing JARs with this feature enabled will result in a compile-time break when 
+                     consumers bump their dependency on the JAR. This is because the return types of every endpoint with
+                     associated errors will change.
 
 ### Known Tag Values