3rd party class customization

api/src/main/java/jakarta/json/bind/JsonbConfig.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, 2020 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2021 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -21,6 +21,7 @@
 import jakarta.json.bind.config.PropertyNamingStrategy;
 import jakarta.json.bind.config.PropertyVisibilityStrategy;
 
+import jakarta.json.bind.customization.TypeCustomization;
 import jakarta.json.bind.serializer.JsonbDeserializer;
 import jakarta.json.bind.serializer.JsonbSerializer;
 
@@ -126,6 +127,11 @@ public class JsonbConfig {
      */
     public static final String DESERIALIZERS = "jsonb.derializers";
 
+    /**
+     * Property used to specify runtime type customizations.
+     */
+    public static final String TYPE_CUSTOMIZATIONS = "jsonb.type-customizations";
+
     /**
      * Property used to specify custom binary data strategy.
      */
@@ -360,6 +366,21 @@ public final JsonbConfig withDeserializers(final JsonbDeserializer... deserializ
         return this;
     }
 
+    /**
+     * Property used to specify custom runtime type customizations.
+     *
+     * Configures value of {@link #TYPE_CUSTOMIZATIONS} property.
+     *
+     * Calling withTypeCustomizations more than once will merge the type customizations with previous value.
+     *
+     * @param typeCustomizations Type customizations which affects deserialization and serialization of the customized types.
+     * @return This JsonbConfig instance.
+     */
+    public final JsonbConfig withTypeCustomizations(final TypeCustomization... typeCustomizations) {
+        mergeProperties(TYPE_CUSTOMIZATIONS, typeCustomizations, TypeCustomization.class);
+        return this;
+    }
+
     /**
      * Property used to specify custom binary data strategy.
      *

api/src/main/java/jakarta/json/bind/customization/CreatorCustomization.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2021 Oracle and/or its affiliates. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0, which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the
+ * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
+ * version 2 with the GNU Classpath Exception, which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ */
+
+package jakarta.json.bind.customization;
+
+import java.util.List;
+import java.util.Optional;
+
+import jakarta.json.bind.spi.JsonbProvider;
+
+/**
+ * Decorated creator customization.
+ */
+public interface CreatorCustomization {
+
+    /**
+     * Create new {@link CreatorCustomizationBuilder} instance.
+     *
+     * Builder created via this method targets constructors of the class it is bound to.
+     *
+     * @return new creator customization builder instance
+     */
+    static CreatorCustomizationBuilder builder() {
+        return JsonbProvider.provider().newCreatorCustomizationBuilder();
+    }
+
+    /**
+     * Create new {@link CreatorCustomizationBuilder} instance based on creator method name.
+     *
+     * @return new creator customization builder instance
+     */
+    static CreatorCustomizationBuilder builder(String methodName) {
+        return JsonbProvider.provider().newCreatorCustomizationBuilder(methodName);
+    }
+
+    /**
+     * Return creator method name if has been specified.
+     * If the name is empty, it is handled as if it is null.
+     *
+     * @return specified creator method name, otherwise empty
+     */
+    Optional<String> factoryMethodName();
+
+    /**
+     * Return {@link List} of the registered parameters. The order of the parameters needs to be the same as they were added.
+     * If no parameters were added, empty {@link List} is returned.
+     *
+     * @return creator parameters
+     */
+    List<ParamCustomization> params();
+
+}

api/src/main/java/jakarta/json/bind/customization/CreatorCustomizationBuilder.java

@@ -0,0 +1,89 @@
+/*
+ * Copyright (c) 2021 Oracle and/or its affiliates. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0, which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the
+ * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
+ * version 2 with the GNU Classpath Exception, which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ */
+
+package jakarta.json.bind.customization;
+
+import java.util.function.Consumer;
+
+/**
+ * Builder of the {@link CreatorCustomization} instance.
+ *
+ * When no creator method name is specified, it is assumed that creator is constructor.
+ */
+public interface CreatorCustomizationBuilder {
+
+    /**
+     * Add {@link ParamCustomization} instance.
+     *
+     * All creator parameters are required to be added in exact order as they are on decorated factory method/constructor.
+     *
+     * @param creatorParam creator parameter
+     * @return updated builder instance
+     */
+    CreatorCustomizationBuilder addParameter(ParamCustomization creatorParam);
+
+    /**
+     * Add new {@link ParamCustomization} of the property.
+     * <br>
+     * Shortcut method to the {@link #addParameter(ParamCustomization)}. It is not required to create {@link CreatorCustomizationBuilder}
+     * since this method will create {@link ParamCustomization} based on the provided parameter class and json name and by calling
+     * {@link ParamCustomization#create(Class, String)} method. No further customizations will be applied.
+     * <br>
+     * All creator parameters are required to be added in exact order as they are on decorated factory method/constructor.
+     *
+     * @param parameterClass class of the parameter
+     * @param jsonName json name of the parameter
+     * @return updated builder instance
+     */
+    default CreatorCustomizationBuilder addParameter(Class<?> parameterClass, String jsonName) {
+        return addParameter(ParamCustomization.create(parameterClass, jsonName));
+    }
+
+    /**
+     * Add new {@link PropertyCustomization} of the property.
+     * <br>
+     * Shortcut method to the {@link #addParameter(ParamCustomization)}. It is not required to create {@link CreatorCustomizationBuilder}
+     * since this method will create is based on the provided parameter class and json name. Created builder is provided over
+     * the paramBuilder.
+     * <br>
+     * All creator parameters are required to be added in exact order as they are on decorated factory method/constructor.
+     * <br>
+     * Example usage:
+     * <pre>{@code
+     * creatorBuilder.addParameter(String.class, "jsonName", paramBuilder -> paramBuilder.nillable(true));
+     * }</pre>
+     *
+     * @param parameterClass class of the parameter
+     * @param jsonName json name of the parameter
+     * @param paramBuilder builder used to customize parameter
+     * @return updated builder instance
+     */
+    default CreatorCustomizationBuilder addParameter(Class<?> parameterClass,
+                                                     String jsonName,
+                                                     Consumer<ParamCustomizationBuilder> paramBuilder) {
+        ParamCustomizationBuilder builder = ParamCustomization.builder(parameterClass, jsonName);
+        paramBuilder.accept(builder);
+        return addParameter(builder.build());
+    }
+
+    /**
+     * Build the new instance of the {@link CreatorCustomization}.
+     *
+     * @return new {@link CreatorCustomization} instance
+     */
+    CreatorCustomization build();
+
+}

api/src/main/java/jakarta/json/bind/customization/JsonbCustomization.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2021 Oracle and/or its affiliates. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0, which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the
+ * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
+ * version 2 with the GNU Classpath Exception, which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ */
+
+package jakarta.json.bind.customization;
+
+import java.text.DateFormat;
+import java.text.NumberFormat;
+import java.util.Optional;
+
+import jakarta.json.bind.adapter.JsonbAdapter;
+import jakarta.json.bind.serializer.JsonbDeserializer;
+
+/**
+ * Common interface for all the customizations.
+ */
+public interface JsonbCustomization {
+
+    /**
+     * Return {@link NumberFormat} specified to the required {@link Scope}.
+     *
+     * @param scope required scope
+     * @return specified {@link NumberFormat} instance, otherwise empty
+     */
+    Optional<NumberFormat> numberFormat(Scope scope);
+
+    /**
+     * Return {@link DateFormat} specified to the required {@link Scope}.
+     *
+     * @param scope required scope
+     * @return specified {@link DateFormat} instance, otherwise empty
+     */
+    Optional<DateFormat> dateFormat(Scope scope);
+
+    /**
+     * Return {@link JsonbDeserializer} of the component.
+     *
+     * @return component deserializer instance, otherwise empty
+     */
+    Optional<JsonbDeserializer<?>> deserializer();
+
+    /**
+     * Return {@link JsonbAdapter} of the component.
+     *
+     * @return component adapter instance, otherwise empty
+     */
+    Optional<JsonbAdapter<?, ?>> adapter();
+
+    /**
+     * Return if the component can be nillable in the given {@link Scope}.
+     *
+     * @param scope required scope
+     * @return property nillable state, otherwise empty
+     */
+    Optional<Boolean> nillable(Scope scope);
+
+}