Is it acceptable to return unmodifiableList or should I return array?

java oop collections api-design
Roman picture Roman · Feb 2, 2010 · Viewed 9.7k times · Source

I have method List<Foo> getFoos () which gets the data from remote server and returns it.

Of course, user shouldn't change number of items of the list because he'll get data not synchronized with data on the server (and if he want change number of items he has special methods like addFoo ()).

First approach was to return array and change method's signature to Foo[] getFoos (). But it's more common in java and more convenient to user to operate with collections so I changed signature to List<Foo> getFoos (). This method always returns

Collections.unmodifiableList (originalList)

So, when user try to change the list he will get RuntimeException.

Are there any recommendations about api design in similar cases?

Answer

deubeulyou picture deubeulyou · Feb 2, 2010

Collections.unmodifiableList is perfectly acceptable and should be faster (no need to create an array).

Edit - In terms of API design, you should just make your JavaDoc clear! People who use a method without reading its doc deserve the surprise :p

Related questions

Why doesn't Java Map extend Collection?

I was surprised by the fact that Map<?,?> is not a Collection<?>. I thought it'd make a LOT of sense if it was declared as such: public interface Map<K,V> extends Collection<…

Read More
What does the 'static' keyword do in a class?

To be specific, I was trying this code: package hello; public class Hello { Clock clock = new Clock(); public static void main(String args[]) { clock.sayTime(); } } But it gave the error Cannot access non-static field in static method main So I …

Read More
Examples of GoF Design Patterns in Java's core libraries

I am learning GoF Java Design Patterns and I want to see some real life examples of them. What are some good examples of these Design Patterns in Java's core libraries?

Read More