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

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

Related Blog Posts
Getting Started with CSS Container Queries
For as long as I’ve been working full-time on the front-end, I’ve heard about the promise of container queries and their potential to solve the majority of our responsive web design needs. And, for as […]
Simple improvements to making decisions in teams
Software development teams need to make a lot of decisions. Functional requirements, non-functional requirements, user experience, API contracts, tech stack, architecture, database schemas, cloud providers, deployment strategy, test strategy, security, and the list goes on. […]
JavaScript Bundle Optimization – Polyfills
If you are lucky enough to only support a small subset of browsers (for example, you are targeting a controlled set of users), feel free to move along. However, if your website is open to […]
Creating Mocks For Unit Testing in Go
Unit testing is an important part of any project, and Go built its framework with a testing package; making unit testing part of the language. This testing framework is good for most scenarios, but you […]