Skip to content
This repository was archived by the owner on Oct 1, 2025. It is now read-only.
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions jdk/src/share/classes/java/lang/ref/Reference.java
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,23 @@ public boolean enqueue() {
return this.queue.enqueue(this);
}


/**
* Throws {@link CloneNotSupportedException}. A {@code Reference} cannot be
* meaningfully cloned. Construct a new {@code Reference} instead.
*
* @apiNote This method is defined in Java SE 8 Maintenance Release 4.
*
* @return never returns normally
* @throws CloneNotSupportedException always
*
* @since 8
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This method is only present in JDK 8u42 (RI) and 8u352 and later releases. It's not in existing 8u releases >= 8u45 and < 8u352. Neither 8 or 8u42 would cause confusion. A suggestion is to use @apiNote to indicate which MR this method is defined:

@apiNote This method is defined in Java SE 8 Maintenance Release 4.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The proposed @apinote looks good.

*/
@Override
protected Object clone() throws CloneNotSupportedException {
throw new CloneNotSupportedException();
}

/* -- Constructors -- */

Reference(T referent) {
Expand Down
104 changes: 104 additions & 0 deletions jdk/test/java/lang/ref/ReferenceClone.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
/*
* Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/

/*
* @test
* @bug 8201793
* @summary Test Reference::clone to throw CloneNotSupportedException
*/

import java.lang.ref.*;

public class ReferenceClone {
private static final ReferenceQueue<Object> QUEUE = new ReferenceQueue<>();
public static void main(String... args) {
ReferenceClone refClone = new ReferenceClone();
refClone.test();
}

public void test() {
// test Reference::clone that throws CNSE
Object o = new Object();
assertCloneNotSupported(new SoftRef(o));
assertCloneNotSupported(new WeakRef(o));
assertCloneNotSupported(new PhantomRef(o));

// Reference subclass may override the clone method
CloneableReference ref = new CloneableReference(o);
try {
ref.clone();
} catch (CloneNotSupportedException e) {}
}

private void assertCloneNotSupported(CloneableRef ref) {
try {
ref.clone();
throw new RuntimeException("Reference::clone should throw CloneNotSupportedException");
} catch (CloneNotSupportedException e) {}
}

// override clone to be public that throws CNSE
interface CloneableRef extends Cloneable {
public Object clone() throws CloneNotSupportedException;
}

class SoftRef extends SoftReference<Object> implements CloneableRef {
public SoftRef(Object referent) {
super(referent, QUEUE);
}
public Object clone() throws CloneNotSupportedException {
return super.clone();
}
}

class WeakRef extends WeakReference<Object> implements CloneableRef {
public WeakRef(Object referent) {
super(referent, QUEUE);
}
public Object clone() throws CloneNotSupportedException {
return super.clone();
}
}

class PhantomRef extends PhantomReference<Object> implements CloneableRef {
public PhantomRef(Object referent) {
super(referent, QUEUE);
}

public Object clone() throws CloneNotSupportedException {
return super.clone();
}
}

// override clone to return a new instance
class CloneableReference extends WeakReference<Object> implements Cloneable {
public CloneableReference(Object referent) {
super(referent, QUEUE);
}

public Object clone() throws CloneNotSupportedException {
return new CloneableReference(this.get());
}
}

}