Skip to main content

Using of Collections.emptyList() the right way in Java 1.5+

It is little strange that no one really uses emptyList like he should in Java.
So this is small post showing how to use the emptyList method in the Collections class.

Question: How to create an empty list ?
lets assume that we have a class Book with multiple titles.
So the class in our examples will be:

import java.util.List;

public class Book {

      private List<String> titles;

      public void setTitles(List<String> titles) {

            this.titles = titles;

      }

      public List<String> getTitles() {

            return titles;

      }

}

Lets say that in our snippet we have something like :

  Book myCrazyBook=new Book();

and we want to assign an empty list to the titles in this book. This is a common scenario if you want to set something to be emptyList in specific case instead of null.

So of course your first try will be something like:
Answer 1:

  myCrazyBook.setTitles(new ArrayList()); 

-WARRNING - ArrayList is a raw type. References to generic type ArrayList<E> should be parameterized

Ok changing to:

  myCrazyBook.setTitles(new ArrayList<String>());   

WTF ? the problem in this answer is not small one :
- you are creating empty ArrayList which basiclly is not needed. ( what if you are in a loop 1000+ empty ArrayLists ? )

Answer 2.

   myCrazyBook.setTitles(Collections.EMPTY_LIST);

-WARNING : Type safety: The expression of type List needs unchecked conversion to conform to List<String>, because the EMPTY_LIST is raw type, which was heavily used before Java 1.5.
The definition of this list is :

    /**

     * The empty list (immutable).  This list is serializable.

     *

     * @see #emptyList()

     */

    public static final List EMPTY_LIST = new EmptyList();

So you see it is not ArrayList or LinkedList or MyCrazyCustomListWhichIUseEveryWhereList.

Answer 3:
Eclipse will tell you this answer : Replace with Collections.emptyList();

      myCrazyBook.setTitles(Collections.emptyList());

COMPILE TIME ERROR: why ? because emptyList invoked like that means List of Objects not List of String. The other thing is that you cannot cast to List<String> because you cannot cast List<Object>  to List<String>.

Answer 4:
You know that there is Collections.emptyList() AND YOU KNOW THAT IT RETURNS List<T>
so your answer is:

            Book myCrazyBook=new Book();

            List<String> titles = Collections.emptyList();

            myCrazyBook.setTitles(titles);

           

And this will work WITHOUT any WARNINGS or ERRORS. The type of the List is taken from the type of the variable that you are trying to assign to.
Of course why you need this local variable ? I want to remove it it is not needed and used, but if you remove it you are in Answer 3. So what can you do ?

Answer 5: The right but strange looking answer.

            Book myCrazyBook=new Book();

            myCrazyBook.setTitles(Collections.<String>emptyList());

Yes this is not a joke there is a dot (.) then the generic type before the method name. This compiles, runs, no warnings thats the real way.
It is a little strange that most people dont know this aspect of generics in Java even I didn't know it, I was thinking that you cannot pass a generic type like this but as it looks you can.

So if you have some static method like this one:

public class Main{

      public static <G> List<G> someGreatMethod(){

            List<G> gList= new ArrayList<G>();

            return gList;

      }

}

you can invoke it with Main.<String>someGreatMethod(); for example.

Comments

Unknown said…
That was very new for me and of course very strange. Thanks it was very clear.
jNayden said…
Very strange indeed :)
Unknown said…
Wow, strange but neat! I didn't know this at all and always used the method proposed in answer 4.
Stilgar said…
I am aware that the article deals with the language syntax but I must point out that passing emptyList to a class that has a public getter that exposes List is a bad practice. The consumer does not know that the implementation is an emptyList and will throw an exception when the add method is called. This makes using emptyList inappropriate. The example would be OK if instead of List the Book class exposed Iterable
Unknown said…
Didn't know that. Thanks for posting it.
jNayden said…
Stilgar : Agree I was needing only the seter for that example, I agree about the getter. :) Shame on eclipse it generates everything :DD kidding :D
Sir Moon said…
"passing emptyList to a class that has a public getter that exposes List is a bad practice"

i have to correct this nonsense. implementations of List are not required to support adding elements, so clients should always be aware that the add method may throw. emptyList() is no worse than unmodifiableList().

Popular Posts

Hibernate Generic DAO.

When you use Hibernate and DAO pattern it is a good idea to use a Generic Base Dao. The fallowing code snippet contains GenericDAO that is a base class for all my DAO classes. This GenericDAO uses HibernateDaoSupport from Spring for its implementation if you want you can use JpaDaoSupport or JdbcDaoSupport in your projects. My Generic DAO interface looks like this : package org.joke.myproject.dao.base; import java.io.Serializable; import java.util.List; /** * @author Naiden Gochev * @param <E> * @param <PK> */ public interface GenericDao<E,PK  extends Serializable> {     PK save(E newInstance);     void update(E transientObject);     void saveOrUpdate(E transientObject);     void delete(E persistentObject);     E findById(PK id);     List<E> findAll();     List<E> f...

RichFaces server-side paging with DataTable.

Most of the component toolkits have build in support for server-side paging this days but in rest of the cases you need to customize a little the data model or data provider or component itself to have data paging. The reason why I write this post is because when I first saw richfaces everythink was perfect except the server-side paging. They have paging but it was client side based on JavaScript witch just doesn't work in many cases and I loose a lot of time to understand all models, which model I must extend and how to do it to create a data model with server side paging. At the current version of RichFaces on the demo page information about how to do server-side paging at least exist http://livedemo.exadel.com/richfaces-demo/richfaces/dataTable.jsf?tab=dataModel&cid=3608154 but like always the JBoss/RedHat/Exadel doesn’t provide us a fast full easy working example and we must loose a lot of time to search for classes in the demo. The reason why I write this post is to giv...

Generate JavaDoc with UML diagrams

In my life many times has happened when I am assigned to a totally new project that I have no idea what it is about, that has to go live in 2 weeks and that I have to fix some issues in this ultra strange code sometimes even code written in different language. On my question is there any documentation the answer is: Yes but it is very old or no. So in short they want me to start working on a project with no documentation at all. My second question is is there a javadoc and the anwer is : yeah … kind of … so I am in a project with 30% javadoc with methods in French language for example ( I don’t know even a single word in French) so in short I am loosing 2 weeks to understand what is using what what is the model what is PersonnePhysique  and what is this crazy domain model. I believe this has happened with everyone of you at least once so what can you do ? You can start digging into the java code like crazy ( like everyone of us have tried many times) You can install ...