Groovy’s .with() and multiple assignment

Multiple assignment

I recently discovered a relatively little-known feature in Groovy called multiple assignment.  As the name indicates, it allows you to assign multiple values to multiple variables in one statement:

The Groovy docs do a good job of explaining the basics, however I did notice one limitation:

“[C]urrently only simple variables may be the target of multiple assignment expressions, e.g. if you have a person class with firstname and lastname fields, you can’t currently do this:

The key words here are “one simple variable.”  If only there were a Groovy construct that let us do this…

.with()

This is where the .with() method comes in.  It allows you to use methods/properties within a closure without having to repeat the object name each time. It does this by setting that object as the delegate of the closure, so any otherwise “undeclared” variables or methods get invoked on that object.  So if we have something like a Dog class and a Color enum:

we would normally set each property individually with:

And by using .with() we could simplify it to:

However, if we were to try multiple assignment here, it wouldn’t work because of the limitation above:

See how .with() can come in handy with multiple assignment?  The entire block could then be reduced to:

Of course, I’d recommend using this feature sparingly, as your code may be a little harder to read, but it is a potential workaround for assigning multiple values to properties!

Igor Shults

About the Author

Object Partners profile.

One thought on “Groovy’s .with() and multiple assignment

  1. Chris Malan says:

    This is neat. I use Groovy in Grails. Don’t think this isn’t appreciated.

    1. More appropriate here is probably Groovy’s map constructor:

      class Person {
      String firstname
      String lastname

      String toString() {
      “$firstname $lastname”
      }
      }

      Person me = [firstname: “Chris”, lastname: “Springer”]
      println me

      For larger objects with many properties, the builder pattern may be even more appropriate. Simple implementations can use @Builder annotation as of Groovy 2.3 to create a basic implementation with any code.

  2. Igor Shults says:

    @Christopher — Yeah the example here was pretty simplified. If you’re literally setting properties immediately after (or while) initializing an object, then this isn’t the best approach. But if you say, are performing an update on multiple properties of an object, then it could be more useful.

  3. Chuck Johnstone says:

    It’s a good solution when you want to assign from an array:

    def csv = ‘first,last,age’

    person.with {
    (first,last,age) = csv.split(‘,’)
    }

    Is a very useful technique.

Leave a Reply to Chris Malan Cancel reply

Your email address will not be published. Required fields are marked *

Related Blog Posts
Android Development for iOS Developers
Android development has greatly improved since the early days. Maybe you tried it out when Android development was done in Eclipse, emulators were slow and buggy, and Java was the required language. Things have changed […]
Add a custom object to your Liquibase diff
Adding a custom object to your liquibase diff is a pretty simple two step process. Create an implementation of DatabaseObject Create an implementation of SnapshotGenerator In my case I wanted to add tracking of Stored […]
Keeping Secrets Out of Terraform State
There are many instances where you will want to create resources via Terraform with secrets that you just don’t want anyone to see. These could be IAM credentials, certificates, RDS DB credentials, etc. One problem […]
Validating Terraform Plans using Open Policy Agent
When developing infrastructure as code using terraform, it can be difficult to test and validate changes without executing the code against a real environment. The feedback loop between writing a line of code and understanding […]