Immutables

General

Category
Free
Tag
APT
License
Apache License, Version 2.0
Registered
Jul 13, 2015
Favorites
1
Link
https://github.com/immutables/immutables
See also
piri
Gson Path
Green Annotations
MethodScope
Ascent

Additional

Language
Java
Version
2.8.8 (May 9, 2020)
Created
Jul 7, 2013
Updated
Mar 8, 2022
Owner
Immutables (immutables)
Contributors
pushbit
Trask Stalnaker (trask)
The Alchemist (The-Alchemist)
Stepan Koltsov (stepancheg)
Auke Schrijnen (auke-)
Simon Legner (simon04)
Jonathan Keljo (jkeljo)
ivysharev
Eugene Lukash (elucash)
kshushlyamin
Engineer (augustotravillio)
mimeya-kp
Luke Driscoll (ldriscoll)
Ben Hamilton (Ben Gertzfield) (bhamiltoncx)
Alessandro Nistico (alienisty)
Stephan Schroevers (Stephan202)
Mark Raynsford (io7m)
Alexander Kune (akune)
Show all (65)65
Activity
Badge
Generate
Download
Source code

Blurb

Read full documentation at http://immutables.org

Modern usage style, aka "sandwich"

// 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 getName();
  List<Integer> getCounts();
  Optional<String> getDescription();

  class Builder extends ImmutableValueObject.Builder {}
  // ImmutableValueObject.Builder will be generated and
  // our builder will inherit and reexport methods as it's 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 standard getters
List<Integer> counts = v.getCounts();
Optional<String> description = v.getDescription();

ImmutableValueObject then would not be used outside of generated type. See about this and other generation styles here

License

   Copyright 2013-2021 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 tab for release history. Archived changelog for earlier releases.