Skip to main content

Groovy beans

A typical Java Bean is a Java class which is serializable, has a public no-arg constructor, private attributes, and getter/setter methods. I'd say this is a lot of stuff for a simple pojo.

Groovy beans did to pojo's what Java could not. They are actually simple. A typical Groovy bean needs to implement java.io.Serializable and add properties to it. We do not need to add any getters/setters, they are added automatically for us.

Here is a simple Groovy bean.


class Customer implements java.io.Serializable {
String firstName //will be a private attribute in the bytecode
String lastName //will be a private attribute
def middleInitial //beans can even contain dynamic properties
}


See.... Groovy beans do not have any getters or setters, and you will also have noticed that the fields are not private. Even though the source does not contain getter/setter methods and private attributes, the bytecode does. When this bean is converted into bytecode all attributes which do not have an access modifier will be treated as properties. What this means is, they will become private attributes and public getter/setter methods will be generated for them.

Now let's create an instance of this bean.


def customer = new Customer()
//Even though this looks like we are accessing public fields
//the bytecode actually invokes the setter methods of these properties
customer.firstName = "John"
customer.lastName = "Gardner"
customer.middleInitial = "U"
println 'Customer's Last Name: ' + customer.lastName


Creating an instance of a Groovy bean is very similar to Java, but assigning values to it's properties seems to be a bit different. When we assign the value "John" to firstName, it seems as if we are assigning a value to a public field. But this is not what happens. Internally Groovy converts this into a call to the setter method for that field. Thus we get the same end result as in Java, but with less verbosity.

We can also use the bean constructor to instantiate and initialize the bean together.


def customer1 = new Customer(firstName: "Bob",
lastName: "Steele",
middleInitial: "Z")


In the above code this is what really happens under the hoods. First the constructor is invoked, followed by calls to the corresponding setter methods.

This is wonderful. Groovy Beans are just like Java Beans, but much simpler and smaller.

Now, you must be thinking, but what if I want to add custom code to the getter or setter? That is simple, simply create your own getter or setter and Groovy will use your code instead of automatically generating it's getter or setter. Your getter/setter can either be public or even protected if you so wish.

But what if we want to create a simple field without getters and setters. How do we prevent Groovy from automatically inserting getter/setters in the bytecode. Again simply create a field and give it an access modifier (like 'private') and Groovy will not auto generate anything for you.

One question that comes to mind, is how do we create package private attributes? Since Groovy 1.6, a package private field can be created by annotating it with @PackageScope

Comments

Unknown said…
hey it was a great information .
keep it up!!

Popular posts from this blog

Planning a User Guide - Part 3/5 - Co-ordinate the Team

Photo by  Helloquence  on  Unsplash This is the third post in a series of five posts on how to plan a user guide. In the first post , I wrote about how to conduct an audience analysis and the second post discussed how to define the overall scope of the manual. Once the overall scope of the user guide is defined, the next step is to coordinate the team that will work on creating the manual. A typical team will consist of the following roles. Many of these roles will be fulfilled by freelancers since they are one-off or intermittent work engagements. At the end of the article, I have provided a list of websites where you can find good freelancers. Creative Artist You'll need to work with a creative artist to design the cover page and any other images for the user guide. Most small to mid-sized companies don't have a dedicated creative artist on their rolls. But that's not a problem. There are several freelancing websites where you can work with great creative ar

Inheritance vs. composition depending on how much is same and how much differs

I am reading the excellent Django book right now. In the 4th chapter on Django templates , there is an example of includes and inheritance in Django templates. Without going into details about Django templates, the include is very similar to composition where we can include the text of another template for evaluation. Inheritance in Django templates works in a way similar to object inheritance. Django templates can specify certain blocks which can be redefined in subtemplates. The subtemplates use the rest of the parent template as is. Now we have all learned that inheritance is used when we have a is-a relationship between classes, and composition is used when we have a contains-a relationship. This is absolutely right, but while reading about Django templates, I just realized another pattern in these relationships. This is really simple and perhaps many of you may have already have had this insight... We use inheritance when we want to allow reuse of the bulk of one object in other

Running your own one person company

Recently there was a post on PuneTech on mom's re-entering the IT work force after a break. Two of the biggest concerns mentioned were : Coping with vast advances (changes) in the IT landscape Balancing work and family responsibilities Since I have been running a one person company for a good amount of time, I suggested that as an option. In this post I will discuss various aspects of running a one person company. Advantages: You have full control of your time. You can choose to spend as much or as little time as you would like. There is also a good chance that you will be able to decide when you want to spend that time. You get to work on something that you enjoy doing. Tremendous work satisfaction. You have the option of working from home. Disadvantages: It can take a little while for the work to get set, so you may not be able to see revenues for some time. It takes a huge amount of discipline to work without a boss, and without deadlines. You will not get the benefits (insuranc