software.amazon.jsii.JsiiSerializable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsii-runtime Show documentation

Java client for jsii runtime

There is a newer version: 1.105.0

package software.amazon.jsii;

import com.fasterxml.jackson.core.TreeNode;

/**
 * Marks a class as serializable from native to javascript.
 * {@link JsiiObject} implements this as well as all generated jsii interfaces.
 * The actual metadata needed for serialization is defined by the @Jsii annotations attached to these
 * types, but Jackson doesn't support selecting serializers by annotations, so we needed a type as a marker.
 * See {@link JsiiObjectMapper} for details.
 */
@Internal
public interface JsiiSerializable {
    /**
     * Serializes this object to JSON. The default behavior is to return an object reference.
     * However, builders implement this method by emitting an actual JSON object of the key/values.
     * @return the jsii/JSON representation of this object
     */
    @Internal
    default TreeNode $jsii$toJson() {
        JsiiObjectRef objRef = JsiiEngine.getInstance().nativeToObjRef(this);
        return objRef.toJson();
    }
}