java: how to use clone() and what about the cast check

Question

This code:

class RawStringIterator {
        java.util.Stack<State> stateStack = new java.util.Stack<State>();
        RawStringIterator(RawStringIterator i) {
              stateStack = (java.util.Stack<State>) i.stateStack.clone();
        }
        /* ... */
}

gives me this warning:

Type safety: Unchecked cast from Object to Stack<Utils.OperatorTree.RawStringIterator.State>

I guess I can ignore the warning here. But I wonder about how to use clone() in general? Do I always have to use a @SuppressWarnings("unchecked") every time I use clone()? Or should I always do the completely redundant extra check?

score 13 · Accepted Answer · edited May 23 '17 at 11:46

13

If you have the choice, the best is not to implement / use clone() at all, because it is a broken API. Just implement / use a copy constructor instead.

If for some pressing reason you must use clone() but can change its implementation, consider declaring Stack<T>.clone() to return Stack<T> instead of Object - covariant return types are legal since Java5.

Update: if the Stack in question is java.util.Stack, consider its Javadoc:

A more complete and consistent set of LIFO stack operations is provided by the Deque interface and its implementations, which should be used in preference to this class.

And e.g. ArrayDeque provides a copy constructor.

edited May 23 '17 at 11:46

Community

1
1

answered Oct 15 '10 at 11:44

Péter Török

114,404
31
268
329

`Stack` is `java.util.Stack` here. So I cannot really change any declaration there. – Albert Oct 15 '10 at 11:54
@Albert, you may still be able to switch to a different collection though - see my update. – Péter Török Oct 15 '10 at 11:57

Bozho · Answer 2 · 2010-10-15T11:54:34.777

2

There is no way to avoid the cast here. clone() returns Object, if it is java.util.Stack, it is not making use of co-variant return types.

If this is not java.util.Stack, then don't implement clone() - it's really hard to get it right. Make a copy-constructor instead.

edited Oct 15 '10 at 11:54

answered Oct 15 '10 at 11:45

Bozho

588,226
146
1,060
1,140

You can (and are recommended to) use covariant return types with your `clone()` - Effective Java 2nd Ed. Item 11 shows explicit examples. – Péter Török Oct 15 '10 at 11:52
yes, but java.util.Stack does not. That was my point. I'll clarify – Bozho Oct 15 '10 at 11:53
No, `java.util.Stack` does not have a copy constructor. Otherwise I would have used it. – Albert Oct 15 '10 at 11:56

score 0 · Answer 3 · answered Oct 15 '10 at 11:44

0

You have very little choice but to ignore it.

Whilst not directly relevant (because you're not writing a clone() method), this entry in the Java Generics FAQ makes good reading (as does the whole FAQ!)

answered Oct 15 '10 at 11:44

dty

18,795
6
56
82

Grodriguez · Answer 4 · 2010-10-15T12:02:24.273

Yes, you'll need to explicitly suppress the warnings each time you use clone().

This is one of the reasons you might prefer to use copy constructors instead of clone(), if available.

By the way in your code, when the RawStringIterator(RawStringIterator i) constructor is used, the first initialisation of stateStack is unnecessary:

class RawStringIterator {
    Stack<State> stateStack = new Stack<State>();
    RawStringIterator(RawStringIterator i) {
          stateStack = (Stack<State>) i.stateStack.clone();
    }
    /* ... */
}

You might want to remove that.

java: how to use clone() and what about the cast check

4 Answers4

Linked

Related