Type List vs type ArrayList in Java [duplicate]
Asked Answered
C

15

635
(1) List<?> myList = new ArrayList<?>();

(2) ArrayList<?> myList = new ArrayList<?>();

I understand that with (1), implementations of the List interface can be swapped. It seems that (1) is typically used in an application regardless of need (myself I always use this).

I am wondering if anyone uses (2)?

Also, how often (and can I please get an example) does the situation actually require using (1) over (2) (i.e. where (2) wouldn't suffice..aside coding to interfaces and best practices etc.)

Clachan answered 17/2, 2010 at 7:40 Comment(5)
More info here: #717097Becker
See my answer about Serialization where you have to use (2)!Tommyetommyrot
You will understand the difference when you solve this problem leetcode.com/problems/kids-with-the-greatest-number-of-candies Where, ArrayList<Boolean> result = new ArrayList<Boolean>(); is faster than List<Boolean> result = new ArrayList<Boolean>();Alviani
@AshishPrajapat No way. An interface is not faster than an implementation. They both use the same object under the hood.Bylaw
https://mcmap.net/q/63960/-type-list-vs-type-arraylist-in-java-duplicate simple answer!!Subplot
J
501

Almost always List is preferred over ArrayList because, for instance, List can be translated into a LinkedList without affecting the rest of the codebase.

If one used ArrayList instead of List, it's hard to change the ArrayList implementation into a LinkedList one because ArrayList specific methods have been used in the codebase that would also require restructuring.

You can read about the List implementations here.

You may start with an ArrayList, but soon after discover that another implementation is the more appropriate choice.

Jobless answered 17/2, 2010 at 7:46 Comment(14)
can you elaborate on changing the implementation of the List? Using my code as an example, to change myList to a LinkedList, wouldn't one still need to call new LinkedList() on the myList?Clachan
oh I commented before your last addition was there..but it all makes sense now..thanksClachan
Yes, and this will be the only code change you will need. Compare with with changing ArrayList to LinkedList in every method. Not to mention having to replaca an ArrayList only method.Jobless
"but also because you may have used ArrayList specific methods" - isn't this an argument for using ArrayList? If you use List, you can't use ArrayList specific methods.Touchdown
@Blrp: The cases that you do need to use ArrayList specific methods are limited. In that case you can very easily convert your List to ArrayList very easily. Most common is to accidentally use an ArrayList method, without that being necessary. Changing ArrayList to List or another List implementation is difficult.Jobless
Something to note is that "ArrayList specific methods" isn't limited to just methods used in ArrayList, but their return types being changed as well (will cause a NoSuchMethodException between Java versions if the internal return type changes). An example of this is the change in the return type of keySet in ConcurrentHashMap between Java 7 and 8.Isopropanol
So why use ArrayList or LinkedList?Ring
I see that the list variable is set to type ArrayList. Why wouldn't it be like C# where you have List<int> someVar = new List<int>() ?Buncombe
why should I change it into LinkedList?Latton
@Alston: LinkedList is another List implementation that is better suited in some cases than ArrayList. See #323215Jobless
But why have ArrayList specific methods if you're just going to restrict its functionality anyways?Legitimacy
It's a bad practice that Java-developers has picked up. It makes no sense to lose concrete type information when you have just declared it. It's not hard to change the declaration and other assignments. And if I have to use functionality specific to ArrayList that List doesn't specify, I already have much more to worry about than changing the declaration and other assignments. It's only good for laziness when you are trying to measure the performance between different collection types. I wouldn't do that in production code if no one forced me.Overlord
Guys, always use Object so you can easily change between implementations of Object without affecting the rest of the code baseHaircloth
@Overlord I had this imposed on meHaircloth
K
130

I am wondering if anyone uses (2)?

Yes. But rarely for a sound reason (IMO).

And people get burned because they used ArrayList when they should have used List:

  • Utility methods like Collections.singletonList(...) or Arrays.asList(...) don't return an ArrayList.

  • Methods in the List API don't guarantee to return a list of the same type.

For example of someone getting burned, in https://mcmap.net/q/65178/-how-can-i-slice-an-arraylist-out-of-an-arraylist-in-java the poster had problems with "slicing" because ArrayList.sublist(...) doesn't return an ArrayList ... and he had designed his code to use ArrayList as the type of all of his list variables. He ended up "solving" the problem by copying the sublist into a new ArrayList.

The argument that you need to know how the List behaves is largely addressed by using the RandomAccess marker interface. Yes, it is a bit clunky, but the alternative is worse.

Also, how often does the situation actually require using (1) over (2) (i.e. where (2) wouldn't suffice..aside 'coding to interfaces' and best practices etc.)

The "how often" part of the question is objectively unanswerable.

(and can I please get an example)

Occasionally, the application may require that you use methods in the ArrayList API that are not in the List API. For example, ensureCapacity(int), trimToSize() or removeRange(int, int). (And the last one will only arise if you have created a subtype of ArrayList that declares the method to be public.)

That is the only sound reason for coding to the class rather than the interface, IMO.

(It is theoretically possible that you will get a slight improvement in performance ... under certain circumstances ... on some platforms ... but unless you really need that last 0.05%, it is not worth doing this. This is not a sound reason, IMO.)


You can’t write efficient code if you don’t know whether random access is efficient or not.

That is a valid point. However, Java provides better ways to deal with that; e.g.

public <T extends List & RandomAccess> void test(T list) {
    // do stuff
}

If you call that with a list that does not implement RandomAccess you will get a compilation error.

You could also test dynamically ... using instanceof ... if static typing is too awkward. And you could even write your code to use different algorithms (dynamically) depending on whether or not a list supported random access.

Note that ArrayList is not the only list class that implements RandomAccess. Others include CopyOnWriteList, Stack and Vector.

I've seen people make the same argument about Serializable (because List doesn't implement it) ... but the approach above solves this problem too. (To the extent that it is solvable at all using runtime types. An ArrayList will fail serialization if any element is not serializable.)


Finally, I'm not going to say "because its is good style". That "reason" is both a circular argument ("Why is it 'good style'?") and an appeal to an unstated (and probably non-existent!) higher authority ("Who says it is 'good style'?").

(I do think it is good style to program to the interface, but I'm not going to give that as a reason. It is better for you to understand the real reasons and come to the (IMO) correct conclusions for yourself. The correct conclusion may not always be the same ... depending on the context.)

Kensell answered 17/2, 2010 at 7:50 Comment(1)
what an enjoyable answerGravestone
C
49

For example you might decide a LinkedList is the best choice for your application, but then later decide ArrayList might be a better choice for performance reason.

Use:

List list = new ArrayList(100); // will be better also to set the initial capacity of a collection 

Instead of:

ArrayList list = new ArrayList();

For reference:

enter image description here

(posted mostly for Collection diagram)

Crinite answered 9/9, 2014 at 15:12 Comment(0)
C
29

It is considered good style to store a reference to a HashSet or TreeSet in a variable of type Set.

Set<String> names = new HashSet<String>();

This way, you have to change only one line if you decide to use a TreeSet instead.

Also, methods that operate on sets should specify parameters of type Set:

public static void print(Set<String> s)

Then the method can be used for all set implementations.

In theory, we should make the same recommendation for linked lists, namely to save LinkedList references in variables of type List. However, in the Java library, the List interface is common to both the ArrayList and the LinkedList class. In particular, it has get and set methods for random access, even though these methods are very inefficient for linked lists.

You can’t write efficient code if you don’t know whether random access is efficient or not.

This is plainly a serious design error in the standard library, and I cannot recommend using the List interface for that reason.

To see just how embarrassing that error is, have a look at the source code for the binarySearch method of the Collections class. That method takes a List parameter, but binary search makes no sense for a linked list. The code then clumsily tries to discover whether the list is a linked list, and then switches to a linear search!

The Set interface and the Map interface, are well designed, and you should use them.

Cryptology answered 21/8, 2013 at 11:46 Comment(3)
Upvoted for saying specifically what the problem is in hiding ArrayList vs LinkedList behind List.Suki
This deserves more upvotes. Cleared my doubt if I should continue using ArrayList or List. If I'm seeking performance and I don't need random access, ArrayList is the answer!Sirmons
Note however, that there is a marker interface called RandomAccess that is applied to all standard List subclasses that have efficient random access. For instance ArrayList implements this, and LinkedList doesn't. You can use this to choose between algorithms that require random access or not.Kensell
P
16

When you write List, you actually tell, that your object implements List interface only, but you don't specify what class your object belongs to.

When you write ArrayList, you specify that your object class is a resizable-array.

So, the first version makes your code more flexible in future.

Look at Java docs:

Class ArrayList - Resizable-array implementation of the List interface.

Interface List - An ordered collection (also known as a sequence). The user of this interface has precise control over where in the list each element is inserted.

Array - container object that holds a fixed number of values of a single type.

Pyxie answered 5/12, 2013 at 17:14 Comment(1)
To me this explanation was the easiest to understand for a "not-a-guru" JAVA programmer like me: to the actual point, not long explanation with words that only professors would understand, practical - thank you!Columbia
P
15

I use (2) if code is the "owner" of the list. This is for example true for local-only variables. There is no reason to use the abstract type List instead of ArrayList. Another example to demonstrate ownership:

public class Test {

    // This object is the owner of strings, so use the concrete type.
    private final ArrayList<String> strings = new ArrayList<>();

    // This object uses the argument but doesn't own it, so use abstract type.
    public void addStrings(List<String> add) {
        strings.addAll(add);
    }

    // Here we return the list but we do not give ownership away, so use abstract type. This also allows to create optionally an unmodifiable list.
    public List<String> getStrings() {
        return Collections.unmodifiableList(strings);
    }

    // Here we create a new list and give ownership to the caller. Use concrete type.
    public ArrayList<String> getStringsCopy() {
        return new ArrayList<>(strings);
    }
}
Piegari answered 21/4, 2013 at 12:20 Comment(4)
What if you decide for some reason that a LinkedList is going to work better than an ArrayList, you'd have to change the signatures of the assessor methods, which also means thing using those methods will have to be reviewed and possibly refactored... which may chain all the way up to the highest level.Shellback
@Shellback - you missed that getStrings returns a List, rather than ArrayList. Any caller which should be dealing with the member in an abstract way, will use that accessor.Suki
@Suki I was referring to getStringsCopy() which creates a copy of strings. strings is an internal variable, so you can change it as much as you need to to cater to evolving requirements. But the interface (the public methods) should not change if you can help it. Returning an ArrayList locks the class to using an ArrayList implementation, when ArrayList is merely a List using arrays to implement the behaviour, so it has no added functionality over List at all.Shellback
I agree that it is usually not a good idea to have public methods receive or return concrete types like ArrayList. But @Piegari also has a point with his "owner" definition. If the owner knows that the List has to be of a certain type then he has to insure that and therefore declare it. See also my answer about SerializationTommyetommyrot
C
10
(3) Collection myCollection = new ArrayList<?>();

I am using this typically. And only if I need List methods, I will use List. Same with ArrayList. You always can switch to more "narrow" interface, but you can't switch to more "wide".

Cryotherapy answered 17/2, 2010 at 7:51 Comment(4)
Is this a thing people do? By this reasoning I should be using Object everywhere. I can think of very few designs that as vague enough to need to to use the Collection interface directly. I'm going to assume by the 8 upvotes that at least 7 other people do this...Jorry
@OmarKooheji That made me laugh :) But it's still a valid point!Ventricular
I look forward to the day when our tools will examine which methods (members) are used, and tell us the narrowest declaration that includes those methods. BUT if we then attempt to use a method of wider scope, will tell us that we could use that method, if we changed the variable type.Suki
If an application needs methods of the Collection interface only then it's an acceptable solution. And if an application uses methods of Object class only then Object o = <any object>; is an acceptable solution as well.Wadewadell
M
10

I think the people who use (2) don't know the Liskov substitution principle or the Dependency inversion principle. Or they really have to use ArrayList.

Maribelmaribelle answered 17/2, 2010 at 7:55 Comment(0)
T
10

Actually there are occasions where (2) is not only preferred but mandatory and I am very surprised, that nobody mentions this here.

Serialization!

If you have a serializable class and you want it to contain a list, then you must declare the field to be of a concrete and serializable type like ArrayList because the List interface does not extend java.io.Serializable

Obviously most people do not need serialization and forget about this.

An example:

public class ExampleData implements java.io.Serializable {

// The following also guarantees that strings is always an ArrayList.
private final ArrayList<String> strings = new ArrayList<>();
Tommyetommyrot answered 14/11, 2016 at 10:22 Comment(1)
In practice, there are few cases where you need to know at compile time that the implementation class of some variable implements Serializable. And when you do, you can do something like this: public <T extends List & Serializable> void test(T list) { ... }.Kensell
S
9

Out of the following two:

(1) List<?> myList = new ArrayList<?>();
(2) ArrayList<?> myList = new ArrayList<?>();

First is generally preferred. As you will be using methods from List interface only, it provides you the freedom to use some other implementation of List e.g. LinkedList in future. So it decouples you from specific implementation. Now there are two points worth mentioning:

  1. We should always program to interface. More here.
  2. You will almost always end up using ArrayList over LinkedList. More here.

I am wondering if anyone uses (2)

Yes sometimes (read rarely). When we need methods that are part of implementation of ArrayList but not part of the interface List. For example ensureCapacity.

Also, how often (and can I please get an example) does the situation actually require using (1) over (2)

Almost always you prefer option (1). This is a classical design pattern in OOP where you always try to decouple your code from specific implementation and program to the interface.

Subplot answered 3/7, 2015 at 8:40 Comment(1)
I find this answer simple and helpful.Enticement
R
5

List is an interface. It doesn't have methods. When you call a method on a List reference, it in fact calls the method of ArrayList in both cases.

And for the future you can change List obj = new ArrayList<> to List obj = new LinkList<> or other types which implement List interface.

Reputable answered 27/10, 2015 at 11:50 Comment(1)
You should say it differently : List has method but they are not implemented You cant't say "It doesn't have methods."Deoxyribose
R
4

Somebody asked this again (duplicate) which made me go a little deeper on this issue.

public static void main(String[] args) {
    List<String> list = new ArrayList<String>();
    list.add("a");
    list.add("b");

    ArrayList<String> aList = new ArrayList<String>();
    aList.add("a");
    aList.add("b");

}

If we use a bytecode viewer (I used http://asm.ow2.org/eclipse/index.html) weĺl see the following (only list initialization and assignment) for our list snippet:

   L0
    LINENUMBER 9 L0
    NEW ArrayList
    DUP
    INVOKESPECIAL ArrayList.<init> () : void
    ASTORE 1
   L1
    LINENUMBER 10 L1
    ALOAD 1: list
    LDC "a"
    INVOKEINTERFACE List.add (Object) : boolean
    POP
   L2
    LINENUMBER 11 L2
    ALOAD 1: list
    LDC "b"
    INVOKEINTERFACE List.add (Object) : boolean
    POP

and for alist:

   L3
    LINENUMBER 13 L3
    NEW java/util/ArrayList
    DUP
    INVOKESPECIAL java/util/ArrayList.<init> ()V
    ASTORE 2
   L4
    LINENUMBER 14 L4
    ALOAD 2
    LDC "a"
    INVOKEVIRTUAL java/util/ArrayList.add (Ljava/lang/Object;)Z
    POP
   L5
    LINENUMBER 15 L5
    ALOAD 2
    LDC "b"
    INVOKEVIRTUAL java/util/ArrayList.add (Ljava/lang/Object;)Z
    POP

The difference is list ends up calling INVOKEINTERFACE whereas aList calls INVOKEVIRTUAL. Accoding to the Bycode Outline Plugin reference,

invokeinterface is used to invoke a method declared within a Java interface

while invokevirtual

invokes all methods except interface methods (which use invokeinterface), static methods (which use invokestatic), and the few special cases handled by invokespecial.

In summary, invokevirtual pops objectref off the stack while for invokeinterface

the interpreter pops 'n' items off the operand stack, where 'n' is an 8-bit unsigned integer parameter taken from the bytecode. The first of these items is objectref, a reference to the object whose method is being called.

If I understand this correctly, the difference is basically how each way retrieves objectref.

Rittenhouse answered 23/12, 2016 at 11:6 Comment(1)
Ermm ... this analysis is moot. In reality, the JIT compiler performs global analysis to determine if method calls need to do virtual (dispatching) method calls. Many / most INVOKEVIRTUAL bytecode instructions turn into non-dispatching call sequences at the native code level.Kensell
A
3

The only case that I am aware of where (2) can be better is when using GWT, because it reduces application footprint (not my idea, but the google web toolkit team says so). But for regular java running inside the JVM (1) is probably always better.

Antoineantoinetta answered 17/2, 2010 at 7:54 Comment(0)
A
2

I would say that 1 is preferred, unless

  • you are depending on the implementation of optional behavior* in ArrayList, in that case explicitly using ArrayList is more clear
  • You will be using the ArrayList in a method call which requires ArrayList, possibly for optional behavior or performance characteristics

My guess is that in 99% of the cases you can get by with List, which is preferred.

  • for instance removeAll, or add(null)
Amary answered 17/2, 2010 at 7:47 Comment(0)
P
2

List interface have several different classes - ArrayList and LinkedList. LinkedList is used to create an indexed collections and ArrayList - to create sorted lists. So, you can use any of it in your arguments, but you can allow others developers who use your code, library, etc. to use different types of lists, not only which you use, so, in this method

ArrayList<Object> myMethod (ArrayList<Object> input) {
   // body
}

you can use it only with ArrayList, not LinkedList, but you can allow to use any of List classes on other places where it method is using, it's just your choise, so using an interface can allow it:

List<Object> myMethod (List<Object> input) {
   // body
}

In this method arguments you can use any of List classes which you want to use:

List<Object> list = new ArrayList<Object> ();

list.add ("string");

myMethod (list);

CONCLUSION:

Use the interfaces everywhere when it possible, don't restrict you or others to use different methods which they want to use.

Particular answered 15/6, 2018 at 21:38 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.