Custom Gson TypeAdapter implementations, annotation-driven TypeAdapterFactory extensions, and a centralized GsonSettings builder for configuring Gson instances. Provides adapters for Color, Instant, OffsetDateTime, String (with null-safety), and UUID, plus factories for Optional unwrapping, case-insensitive enums, nested JSON path mapping, dynamic key capture, lenient type filtering, string-delimited pair splitting, and post-deserialization callbacks.

• Features
  • Adapters
  • Factories
  • Annotations
• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Quick Start
  • Custom Configuration
  • Individual Adapters
• Architecture
  • Package Overview
  • Project Structure
• Dependencies
• Contributing
• License

GsonSettings provides immutable, builder-based configuration for Gson instances. Call GsonSettings.defaults() to get a pre-configured instance with all adapters and factories registered, or use GsonSettings.builder() to assemble a custom configuration.

Add the JitPack repository and dependency to your build.gradle.kts:

repositories {
    maven(url = "https://jitpack.io")
}

dependencies {
    implementation("com.github.simplified-dev:gson-extras:master-SNAPSHOT")
}

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    implementation 'com.github.simplified-dev:gson-extras:master-SNAPSHOT'
}

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependency>
    <groupId>com.github.simplified-dev</groupId>
    <artifactId>gson-extras</artifactId>
    <version>master-SNAPSHOT</version>
</dependency>

GsonSettings.defaults() returns a fully configured settings instance with all built-in adapters and factories registered:

import com.google.gson.Gson;
import dev.simplified.gson.GsonSettings;

Gson gson = GsonSettings.defaults().create();

// Serialize
String json = gson.toJson(myObject);

// Deserialize
MyObject obj = gson.fromJson(json, MyObject.class);

Use defaults() as a starting point and mutate() to customize:

Gson gson = GsonSettings.defaults()
    .mutate()
    .isPrettyPrint()
    .isSerializingNulls()
    .withStringType(GsonSettings.StringType.NULL)
    .build()
    .create();

Or build from scratch with GsonSettings.builder() for full control:

Gson gson = GsonSettings.builder()
    .withTypeAdapter(UUID.class, new UUIDTypeAdapter())
    .withFactories(new OptionalTypeAdapterFactory())
    .isPrettyPrint()
    .build()
    .create();

You can also register adapters directly on a GsonBuilder:

import com.google.gson.GsonBuilder;
import dev.simplified.gson.adapter.InstantTypeAdapter;
import dev.simplified.gson.adapter.UUIDTypeAdapter;

Gson gson = new GsonBuilder()
    .registerTypeAdapter(Instant.class, new InstantTypeAdapter())
    .registerTypeAdapter(UUID.class, new UUIDTypeAdapter())
    .create();

src/main/java/dev/simplified/gson/
├── GsonSettings.java
├── Capture.java
├── Extract.java
├── Lenient.java
├── PostInit.java
├── SerializedPath.java
├── Split.java
├── adapter/
│   ├── ColorTypeAdapter.java
│   ├── InstantTypeAdapter.java
│   ├── OffsetDateTimeTypeAdapter.java
│   ├── StringTypeAdapter.java
│   └── UUIDTypeAdapter.java
└── factory/
    ├── CaptureTypeAdapterFactory.java
    ├── CaseInsensitiveEnumTypeAdapterFactory.java
    ├── LenientTypeAdapterFactory.java
    ├── OptionalTypeAdapterFactory.java
    ├── PostInitTypeAdapterFactory.java
    ├── SerializedPathTypeAdaptorFactory.java
    └── SplitTypeAdapterFactory.java

See CONTRIBUTING.md for development setup, code style guidelines, and how to submit a pull request.

This project is licensed under the Apache License 2.0 - see LICENSE.md for the full text.