1berry/openjdk
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

8233795: Consider adding a notion of a Value-based class to API Documentation index

Browse Source 
Reviewed-by: hannesw
This commit is contained in:
Pavel Rappo 2020-01-24 12:51:34 +00:00
parent d97fe7b050
commit abadeda8a5
1 changed files with 26 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/java.base/share/classes/java/lang/doc-files/ValueBased.html
View File

@ -1,11 +1,35 @@
<!doctype html> <!doctype html>
<!--
Copyright (c) 2013, 2020, 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. Oracle designates this
particular file as subject to the "Classpath" exception as provided
by Oracle in the LICENSE file that accompanied this code.
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.
-->
<html lang="en"> <html lang="en">
<head> <head>
<title>Value-based Classes</title> <title>Value-based Classes</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head> </head>
<body> <body>
<h1 id="ValueBased">Value-based Classes</h1> <h1 id="ValueBased">{@index "Value-based Classes"}</h1>
Some classes, such as <code>java.util.Optional</code> and Some classes, such as <code>java.util.Optional</code> and
<code>java.time.LocalDateTime</code>, are <em>value-based</em>. Instances of a <code>java.time.LocalDateTime</code>, are <em>value-based</em>. Instances of a
@ -23,7 +47,7 @@ value-based class:
<li>are considered equal solely based on <code>equals()</code>, not <li>are considered equal solely based on <code>equals()</code>, not
based on reference equality (<code>==</code>);</li> based on reference equality (<code>==</code>);</li>
<li>do not have accessible constructors, but are instead instantiated <li>do not have accessible constructors, but are instead instantiated
through factory methods which make no committment as to the identity through factory methods which make no commitment as to the identity
of returned instances;</li> of returned instances;</li>
<li>are <em>freely substitutable</em> when equal, meaning that interchanging <li>are <em>freely substitutable</em> when equal, meaning that interchanging
any two instances <code>x</code> and <code>y</code> that are equal any two instances <code>x</code> and <code>y</code> that are equal