hf / immu Goto Github PK

Provide @Nullable and @NonNull annotation for the getter methods depending on their @Required annotation

Type wrappers usually serve the purpose of wrapping an existing type with a different type in order to better convey meaning. For example, if an object has a unique identifier, usually that would be a String. However, it is a special kind of String. Using it all over the place to refer to the unique identifier is a code smell: it can lead to errors (what id was it?), and it is not descriptive. One can utilize a type wrapper around that String to standardize the usage of the unique identifier as a UniqueIdentifier.

@Immu
interface UniqueIdentifer {
  @Required String identifier();
}

It is slightly bothersome to write UniqueIdentifierBuilder.create().identifier(theIdentifier).build() to create an instance of UniqueIdentifier.

Use UniqueIdentifierBuilder.create(theIdentifier) => UniqueIdentifier for this use case:

• the Immu has only one property
• the property is marked as Required

Add support for Optional-like types in interfaces. Those will not be compatible with @Required.

Currently all @Required properties will be present, in order, in the generated builder's creator as parameters. This has a few drawbacks:

• if many of the properties are @Required then the argument list is too long
• if you change the order of same-type properties, the order in the creator will be reversed and noticing the change may become challenging for users

A solution to this would be to generate a parameterless create() method and lazily verify that the @Required properties have been supplied to the builder when build() will be called.

An efficient implementation would be to store an array of ints. Each int is a bit-field representing at most 32 properties. The ints are initialized to ~0 and each property gets a unique bit in a specific int position. The first time a property is set on the builder, its bit is flipped to 0. Upon build() iterate over the few integers representing all required properties and throw an exception if not all ints are 0.