infernap12/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2026-06-12 21:45:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

8386328: TemporalField.adjustInto Javadoc incorrectly uses 1-argument method signatures

Browse Source 
Reviewed-by: jlu, iris
This commit is contained in:
Naoto Sato 2026-06-11 18:26:56 +00:00
parent c3a3fb2e50
commit d84d85f2de
6 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/java.base/share/classes/java/time/temporal/Temporal.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2026, 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
@ -392,8 +392,8 @@ public interface Temporal extends TemporalAccessor {
* The second is to use {@link TemporalUnit#between(Temporal, Temporal)}:
* <pre>
* // these two lines are equivalent
* temporal = start.until(end, unit);
* temporal = unit.between(start, end);
* amount = start.until(end, unit);
* amount = unit.between(start, end);
* </pre>
* The choice should be made based on which makes the code more readable.
* <p>

8
src/java.base/share/classes/java/time/temporal/TemporalAmount.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2026, 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
@ -145,9 +145,9 @@ public interface TemporalAmount {
* <pre>
* // These two lines are equivalent, but the second approach is recommended
* dateTime = amount.addTo(dateTime);
* dateTime = dateTime.plus(adder);
* dateTime = dateTime.plus(amount);
* </pre>
* It is recommended to use the second approach, {@code plus(TemporalAmount)},
* It is recommended to use the second approach, {@code plus(amount)},
* as it is a lot clearer to read in code.
*
* @implSpec
@ -189,7 +189,7 @@ public interface TemporalAmount {
* dateTime = amount.subtractFrom(dateTime);
* dateTime = dateTime.minus(amount);
* </pre>
* It is recommended to use the second approach, {@code minus(TemporalAmount)},
* It is recommended to use the second approach, {@code minus(amount)},
* as it is a lot clearer to read in code.
*
* @implSpec

26
src/java.base/share/classes/java/time/temporal/TemporalField.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2026, 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
@ -186,10 +186,10 @@ public interface TemporalField {
* The second is to use {@link TemporalAccessor#isSupported(TemporalField)}:
* <pre>
* // these two lines are equivalent, but the second approach is recommended
* temporal = thisField.isSupportedBy(temporal);
* temporal = temporal.isSupported(thisField);
* supported = thisField.isSupportedBy(temporal);
* supported = temporal.isSupported(thisField);
* </pre>
* It is recommended to use the second approach, {@code isSupported(TemporalField)},
* It is recommended to use the second approach, {@code isSupported(thisField)},
* as it is a lot clearer to read in code.
* <p>
* Implementations should determine whether they are supported using the fields
@ -216,10 +216,10 @@ public interface TemporalField {
* The second is to use {@link TemporalAccessor#range(TemporalField)}:
* <pre>
* // these two lines are equivalent, but the second approach is recommended
* temporal = thisField.rangeRefinedBy(temporal);
* temporal = temporal.range(thisField);
* range = thisField.rangeRefinedBy(temporal);
* range = temporal.range(thisField);
* </pre>
* It is recommended to use the second approach, {@code range(TemporalField)},
* It is recommended to use the second approach, {@code range(thisField)},
* as it is a lot clearer to read in code.
* <p>
* Implementations should perform any queries or calculations using the fields
@ -244,10 +244,10 @@ public interface TemporalField {
* (or {@link TemporalAccessor#get(TemporalField)}):
* <pre>
* // these two lines are equivalent, but the second approach is recommended
* temporal = thisField.getFrom(temporal);
* temporal = temporal.getLong(thisField);
* value = thisField.getFrom(temporal);
* value = temporal.getLong(thisField);
* </pre>
* It is recommended to use the second approach, {@code getLong(TemporalField)},
* It is recommended to use the second approach, {@code getLong(thisField)},
* as it is a lot clearer to read in code.
* <p>
* Implementations should perform any queries or calculations using the fields
@ -281,10 +281,10 @@ public interface TemporalField {
* The second is to use {@link Temporal#with(TemporalField, long)}:
* <pre>
* // these two lines are equivalent, but the second approach is recommended
* temporal = thisField.adjustInto(temporal);
* temporal = temporal.with(thisField);
* temporal = thisField.adjustInto(temporal, newValue);
* temporal = temporal.with(thisField, newValue);
* </pre>
* It is recommended to use the second approach, {@code with(TemporalField)},
* It is recommended to use the second approach, {@code with(thisField, newValue)},
* as it is a lot clearer to read in code.
* <p>
* Implementations should perform any queries or calculations using the fields

8
src/java.base/share/classes/java/time/temporal/TemporalQueries.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2026, 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
@ -94,10 +94,10 @@ import java.time.chrono.Chronology;
* The second is to use {@link TemporalAccessor#query(TemporalQuery)}:
* <pre>
* // these two lines are equivalent, but the second approach is recommended
* temporal = thisQuery.queryFrom(temporal);
* temporal = temporal.query(thisQuery);
* result = thisQuery.queryFrom(temporal);
* result = temporal.query(thisQuery);
* </pre>
* It is recommended to use the second approach, {@code query(TemporalQuery)},
* It is recommended to use the second approach, {@code query(thisQuery)},
* as it is a lot clearer to read in code.
* <p>
* The most common implementations are method references, such as

14
src/java.base/share/classes/java/time/temporal/TemporalQuery.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2026, 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
@ -81,10 +81,10 @@ import java.time.DateTimeException;
* The second is to use {@link TemporalAccessor#query(TemporalQuery)}:
* <pre>
* // these two lines are equivalent, but the second approach is recommended
* temporal = thisQuery.queryFrom(temporal);
* temporal = temporal.query(thisQuery);
* result = thisQuery.queryFrom(temporal);
* result = temporal.query(thisQuery);
* </pre>
* It is recommended to use the second approach, {@code query(TemporalQuery)},
* It is recommended to use the second approach, {@code query(thisQuery)},
* as it is a lot clearer to read in code.
* <p>
* The most common implementations are method references, such as
@ -115,10 +115,10 @@ public interface TemporalQuery<R> {
* The second is to use {@link TemporalAccessor#query(TemporalQuery)}:
* <pre>
* // these two lines are equivalent, but the second approach is recommended
* temporal = thisQuery.queryFrom(temporal);
* temporal = temporal.query(thisQuery);
* result = thisQuery.queryFrom(temporal);
* result = temporal.query(thisQuery);
* </pre>
* It is recommended to use the second approach, {@code query(TemporalQuery)},
* It is recommended to use the second approach, {@code query(thisQuery)},
* as it is a lot clearer to read in code.
*
* @implSpec

8
src/java.base/share/classes/java/time/temporal/TemporalUnit.java
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2025, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2026, 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
@ -203,10 +203,10 @@ public interface TemporalUnit {
* The second is to use {@link Temporal#plus(long, TemporalUnit)}:
* <pre>
* // these two lines are equivalent, but the second approach is recommended
* temporal = thisUnit.addTo(temporal);
* temporal = temporal.plus(thisUnit);
* temporal = thisUnit.addTo(temporal, amount);
* temporal = temporal.plus(amount, thisUnit);
* </pre>
* It is recommended to use the second approach, {@code plus(TemporalUnit)},
* It is recommended to use the second approach, {@code plus(amount, thisUnit)},
* as it is a lot clearer to read in code.
* <p>
* Implementations should perform any queries or calculations using the units