Git Product home page Git Product logo

callbuilder's Introduction

CallBuilder

Make a builder by defining one function.
(beta: be ready for breaking API changes)

CallBuilder is a Java code generator that finally makes it easy to make a builder class. Builders are great when you have a constructor or method with many parameters. They are even helpful when you have two or more arguments of the same type, since the order is easy to mix up.

Builders are usually hard to write. You will probably need around 4 lines for every field, and if it's an inner class, it makes the file long and cumbersome to navigate. This discourages many people from writing builders, and those people give up and learn to live with brittle, and hard-to-read code. If you want to add multiple setters for a field (common for lists that may have add and addAll), your builder will quickly become a chore to write and a burden to maintain.

CallBuilder changes that. To use it, you can simply write the method or constructor as you normally would, but add the @CallBuilder annotation:

public class Person {
  @CallBuilder
  Person(
      String familyName,
      String givenName,
      List<String> addressLines,
      @Nullable Integer age) {
    // ...
  }
}

Now you will have access to a PersonBuilder class in the same package!

Person friend = new PersonBuilder()
    .setAddressLines(Arrays.asList("1123 Easy Street", "Townplace, XZ"))
    .setAge(22)
    .setGivenName("John")
    .setFamilyName("Doe")
    .build();

With the field styles feature, you can define custom behavior for the fields that are of a certain type. This can make the API more natural and look more like a manually-written builder:

public class Person {
  @CallBuilder
  Person(
      String familyName,
      String givenName,
      @BuilderField(style = ArrayListAdding.class) ArrayList<String> addressLines,
      @Nullable Integer age) {
    // ...
  }
}

This can be used like:

Person friend = new PersonBuilder()
    .addToAddressLines("1123 Easy Street")
    .addToAddressLines("Townplace, XZ")
    .setAge(22)
    .setGivenName("John")
    .setFamilyName("Doe")
    .build();

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.