{"id":30266801,"url":"https://github.com/zapodot/jackson-databind-java-optional","last_synced_at":"2025-08-15T23:25:15.130Z","repository":{"id":17943284,"uuid":"20923517","full_name":"zapodot/jackson-databind-java-optional","owner":"zapodot","description":"A shim library to support mapping Java8 Optionals through Jackson.","archived":false,"fork":false,"pushed_at":"2016-07-17T17:19:30.000Z","size":96,"stargazers_count":15,"open_issues_count":2,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-27T17:56:45.233Z","etag":null,"topics":["jackson-json-processor","java","java-8","optional"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"realjenius/jackson-databind-java8","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zapodot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-06-17T13:05:00.000Z","updated_at":"2021-05-03T17:57:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"dd33abe0-a7a8-4212-bca1-b1bd9463e1f0","html_url":"https://github.com/zapodot/jackson-databind-java-optional","commit_stats":null,"previous_names":["zapodot/jackson-databind-java8"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/zapodot/jackson-databind-java-optional","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zapodot%2Fjackson-databind-java-optional","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zapodot%2Fjackson-databind-java-optional/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zapodot%2Fjackson-databind-java-optional/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zapodot%2Fjackson-databind-java-optional/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zapodot","download_url":"https://codeload.github.com/zapodot/jackson-databind-java-optional/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zapodot%2Fjackson-databind-java-optional/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270644764,"owners_count":24621332,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jackson-json-processor","java","java-8","optional"],"created_at":"2025-08-15T23:25:11.232Z","updated_at":"2025-08-15T23:25:15.110Z","avatar_url":"https://github.com/zapodot.png","language":"Java","readme":"# jackson-databind-java-optional\n[![Build Status](https://travis-ci.org/zapodot/jackson-databind-java-optional.svg)](https://travis-ci.org/zapodot/jackson-databind-java-optional)\n[![Coverage Status](https://img.shields.io/coveralls/zapodot/jackson-databind-java-optional.svg)](https://coveralls.io/r/zapodot/jackson-databind-java-optional?branch=master)\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.zapodot/jackson-databind-java-optional/badge.svg)](http://mvnrepository.com/artifact/org.zapodot/jackson-databind-java-optional)\n[![Analytics](https://ga-beacon.appspot.com/UA-40926073-3/jackson-databind-java-optional/README.md)](https://github.com/igrigorik/ga-beacon)\n\nA shim library to support mapping Java 8 Optional through Jackson. Forked from @realjenuis jackson-databind-java8 project.\n\nThis library is compiled with Java 8 and will thus only be useful in a Java 8 (or higher) runtime environment. \n\n## Alternatives ##\nIf you are starting a new project that requires support for Java 8 combined with Jackson Databind, you should probably have a look at [FasterXML's JDK 8 module](//github.com/FasterXML/jackson-datatype-jdk8). \n\n## Usage\nThe library is distributed through Sonatype's OSS repo\n### Maven dependency\n```xml\n        \u003cdependency\u003e\n            \u003cgroupId\u003eorg.zapodot\u003c/groupId\u003e\n            \u003cartifactId\u003ejackson-databind-java-optional\u003c/artifactId\u003e\n            \u003cversion\u003e2.6.1\u003c/version\u003e\n        \u003c/dependency\u003e\n```\n\n### SBT\n```scala\n    libraryDependencies += \"org.zapodot\" % \"jackson-databind-java-optional\" % \"2.6.1\"\n```\n\n\n### Registering module\nThe module is auto-discoverable using the Jackson ObjectMappers's findAndRegisterModules method\n\n```java\nfinal ObjectMapper mapper = new ObjectMapper().findAndRegisterModules();\n```\n\nIf you are not to crazy about using auto discovery, you can always register the module manually\n```java\nfinal ObjectMapper objectMapper = new ObjectMapper()\n                                          .registerModule(\n                                                new JavaOptionalModule());\n```\n\n### Serialization\nEmpty Optionals will be serialized as JSON nulls.\nExample:\n```java\n    public class Bean {\n\n        public static final String PRESENT_VALUE = \"present\";\n        @JsonProperty\n        private Optional\u003cString\u003e empty = Optional.empty();\n\n        @JsonProperty\n        private Optional\u003cString\u003e notSet;\n\n        @JsonProperty\n        private Optional\u003cString\u003e present = Optional.of(PRESENT_VALUE);\n\n        public static void serialize() {\n            final ObjectMapper mapper = new ObjectMapper().findAndRegisterModules();\n            final String json = mapper.writeValueAsString(new Bean());\n            System.out.println(json); // will print '{\"empty\":null,\"notSet\":null,\"present\":\"present\"}'\n        }\n\n\n    }\n```\n\n### Deserialization\nNulls will be deserialized as _Optional.empty()_\nExample:\n```java\n    public class JavaOptionalDeserializeTest {\n\n        public static class Bean {\n\n            public static final String PRESENT_VALUE = \"present\";\n\n            @JsonProperty\n            private Optional\u003cString\u003e empty = Optional.empty();\n\n            @JsonProperty\n            private Optional\u003cString\u003e notSet;\n\n            @JsonProperty\n            private Optional\u003cString\u003e present = Optional.of(PRESENT_VALUE);\n\n        }\n\n        @Test\n        public void testDeserialize() throws Exception {\n            final Bean bean = new ObjectMapper().findAndRegisterModules()\n                                                .readValue(\"{\\\"empty\\\":null,\\\"notSet\\\":null}\", Bean.class);\n            assertNotNull(bean.empty);\n            assertEquals(Optional.empty(), bean.empty);\n            assertNotNull(bean.notSet);\n            assertEquals(Optional.empty(), bean.notSet);\n            assertEquals(Optional.of(Bean.PRESENT_VALUE), bean.present);\n\n        }\n    }\n```\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzapodot%2Fjackson-databind-java-optional","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzapodot%2Fjackson-databind-java-optional","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzapodot%2Fjackson-databind-java-optional/lists"}