https://github.com/immutables/immutables

Annotation processor to create immutable objects and builders. Feels like Guava's immutable collections but for regular value objects. JSON, Jackson, Gson, JAX-RS integrations included
https://github.com/immutables/immutables

annotation-processor builder gson guava immutable-collections immutable-datastructures immutable-objects immutables jackson java

Last synced: 3 days ago
JSON representation

Annotation processor to create immutable objects and builders. Feels like Guava's immutable collections but for regular value objects. JSON, Jackson, Gson, JAX-RS integrations included

• Host: GitHub
• URL: https://github.com/immutables/immutables
• Owner: immutables
• License: apache-2.0
• Created: 2013-07-07T13:48:23.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2025-01-17T19:16:33.000Z (27 days ago)
• Last Synced: 2025-02-04T05:26:17.469Z (10 days ago)
• Topics: annotation-processor, builder, gson, guava, immutable-collections, immutable-datastructures, immutable-objects, immutables, jackson, java
• Language: Java
• Homepage: http://immutables.org
• Size: 12.4 MB
• Stars: 3,455
• Watchers: 87
• Forks: 279
• Open Issues: 441
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - immutables/immutables - Annotation processor to create immutable objects and builders. Feels like Guava's immutable collections but for regular value objects. JSON, Jackson, Gson, JAX-RS integrations included (Java)
• awesome-ccamel - immutables/immutables - Annotation processor to create immutable objects and builders. Feels like Guava's immutable collections but for regular value objects. JSON, Jackson, Gson, JAX-RS integrations included (Java)

README

        
Read full documentation at http://immutables.org

![CI](https://github.com/immutables/immutables/workflows/CI/badge.svg)

## Modern usage style, aka "sandwich"

```java

// Define abstract value type using interface, abstract class or annotation

@Value.Immutable

public interface ValueObject extends WithValueObject {

  // WithValueObject is not yet generated, We extend With* to inherit `with*` method signatures

  String name();

  List counts();

  Optional description();

  class Builder extends ImmutableValueObject.Builder {}

  // ImmutableValueObject.Builder will be generated and

  // our builder will inherit and reexport methods as its own.

  // Static nested Builder will inherit all the public method

  // signatures of ImmutableValueObject.Builder

} 

// Use generated immutable implementation and builder

ValueObject v =

    new ValueObject.Builder()

        .name("Nameless")

        .description("present")

        .addCounts(1)

        .addCounts(2)

        .build();

v = v.withName("Doe");

//fetch values via accessors

List counts = v.counts();

Optional description = v.description();

```

ImmutableValueObject then would not be used outside generated type. See about this and other generation [styles here](https://immutables.github.io/style.html) 

## License

```

   Copyright 2013-2024 Immutables Authors and Contributors

   Licensed under the Apache License, Version 2.0 (the "License");

   you may not use this file except in compliance with the License.

   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software

   distributed under the License is distributed on an "AS IS" BASIS,

   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

   See the License for the specific language governing permissions and

   limitations under the License.

```

See [releases](https://github.com/immutables/immutables/releases) tab for release history. Archived [changelog](.archive/CHANGELOG.md) for earlier releases.