Javadoc/Nitpick のバックアップ(No.35)

• バックアップ一覧
• 差分 を表示
• 現在との差分 を表示
• 現在との差分 - Visual を表示
• ソース を表示
• Javadoc/Nitpick へ行く。
  • 1 (2011-11-11 (金) 16:34:33)
  • 2 (2012-04-11 (水) 14:04:09)
  • 3 (2012-04-11 (水) 19:00:19)
  • 4 (2012-05-09 (水) 11:53:28)
  • 5 (2012-05-11 (金) 16:46:56)
  • 6 (2012-05-21 (月) 15:00:13)
  • 7 (2012-07-01 (日) 06:40:05)
  • 8 (2012-07-02 (月) 20:55:44)
  • 9 (2013-05-30 (木) 19:29:33)
  • 10 (2013-09-11 (水) 15:50:29)
  • 11 (2014-03-28 (金) 15:57:33)
  • 12 (2014-09-02 (火) 16:30:10)
  • 13 (2014-09-24 (水) 14:42:18)
  • 14 (2014-10-23 (木) 14:19:25)
  • 15 (2014-10-31 (金) 19:00:11)
  • 16 (2014-11-01 (土) 00:46:09)
  • 17 (2015-03-09 (月) 14:46:02)
  • 18 (2015-03-16 (月) 17:28:33)
  • 19 (2015-06-03 (水) 19:05:23)
  • 20 (2015-06-26 (金) 18:04:10)
  • 21 (2015-07-14 (火) 18:16:16)
  • 22 (2016-02-08 (月) 14:15:43)
  • 23 (2017-01-10 (火) 14:18:45)
  • 24 (2017-01-10 (火) 15:26:48)
  • 25 (2017-04-04 (火) 14:13:45)
  • 26 (2017-04-07 (金) 13:51:51)
  • 27 (2017-06-07 (水) 15:35:06)
  • 28 (2017-10-23 (月) 18:41:48)
  • 29 (2017-10-24 (火) 12:56:49)
  • 30 (2017-11-02 (木) 15:34:40)
  • 31 (2017-11-14 (火) 18:13:52)
  • 32 (2018-01-15 (月) 18:56:51)
  • 33 (2018-02-27 (火) 14:35:27)
  • 34 (2018-03-08 (木) 16:34:51)
  • 35 (2018-03-09 (金) 22:20:34)
  • 36 (2018-04-10 (火) 17:38:15)
  • 37 (2018-07-25 (水) 18:02:33)
  • 38 (2019-02-19 (火) 15:43:25)
  • 39 (2019-10-18 (金) 19:05:47)
  • 40 (2022-02-11 (金) 15:05:27)
  • 41 (2022-02-16 (水) 16:17:39)
  • 42 (2022-02-21 (月) 14:04:33)
  • 43 (2022-08-20 (土) 22:15:25)

• title: 翻訳元から author: aterai pubdate: 2010-10-05 description: Java クラスドキュメントで、オリジナルの英語版から修正した方が良さそうな誤字など。

概要

Java(Swing)のクラスドキュメントで、オリジナルの英語版から修正した方が良さそうな箇所をメモしています。

未修正

translateMouseEvent()

• https://docs.oracle.com/javase/8/docs/api/javax/swing/SwingUtilities.html#convertMouseEvent-java.awt.Component-java.awt.event.MouseEvent-java.awt.Component-
  • the source field of the returned event will be set to destination if destination is non-null use the translateMouseEvent() method to translate a mouse event from one component to another without changing the source.
• 修正案
  • translateMouseEvent()というメソッドはどこにも存在しない？
• 参考
  • JDK-8049533 SwingUtilities.convertMouseEvent misses MouseWheelEvent.preciseWheelRotation - Java Bug System
  • Java 9でMouseWheelEventがコピーされない件は修正されているが、同時に指摘されているtranslateMouseEvent()などは未修正

SwingConstants#VERTICAL

• https://docs.oracle.com/javase/8/docs/api/javax/swing/SwingConstants.html#VERTICAL
  • Vertical orientation. Used for scrollbars and sliders.
• 修正案
  • JScrollBarはSwingConstantsを実装していない(java.awt.Adjustableを実装している)ので、progressbars and slidersのほうがよさそう
  • SwingConstants#HORIZONTALも同様

getAlignmentY()

• https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html
  • Ease-of-use constant for getAlignmentX.
  • Ease-of-use constant for getAlignmentY().
• 修正案
  • ()を付ける方に揃える

setAsksAllowsChildren

• https://docs.oracle.com/javase/8/docs/api/javax/swing/tree/DefaultTreeModel.html#setAsksAllowsChildren-boolean-
  • If newvalue is true,
• 修正案
  • If newValue is true,
• メモ
  • JDK-8026776 Broken API names in API doc - Java Bug Systemで既出
    • https://docs.oracle.com/javase/jp/8/docs/api/java/net/URLConnection.html のgetLastModifedなど

TableModelevent

• https://docs.oracle.com/javase/8/docs/api/javax/swing/event/TableModelEvent.html
  • the TableModelevent can be used to specify the following types of changes:
• 修正案
  • the TableModelEvent can be used to specify the following types of changes:

HTML.Attribute.id

• https://docs.oracle.com/javase/8/docs/api/javax/swing/text/html/HTMLDocument.html#getElement-java.lang.String-
  • This is a convenience method for getElement(RootElement, HTML.Attribute.id, id).
• 修正案
  • This is a convenience method for getElement(RootElement, HTML.Attribute.ID, id).

JMX Specification.,

• https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryPoolMXBean.html
  • JMX Specification.,

TableModel#isCellEditable(...)

• https://docs.oracle.com/javase/8/docs/api/javax/swing/table/TableModel.html#isCellEditable-int-int-
  • Returns true if the cell at rowIndex and columnIndex is editable. Otherwise, setValueAt on the cell will not change the value of that cell.
  • Bug ID: 4292804 DefaultTableModel doc confusion between isCellEditable and setValueAt
    • DefaultTableModel は修正されている？、TableModel は関係ない？

文字化け？

• https://docs.oracle.com/javase/8/docs/technotes/guides/swing/1.4/w2k_props.html
  • "win.frame.textColor?????"
  • 「メッセージボックスのフォントカラー」のプロパティー名が文字化け？
  • http://java.sun.com/j2se/1.5.0/ja/docs/ja/guide/swing/1.4/w2k_props.html は、「ウィンドウのフォントカラー」と同じ値になっている

本来は、"win.messagebox.textColor" とか、全然別の値なのか、あるいは、この ページの先頭付近に載っているサンプルコード

String propnames[] = (String[])Toolkit.getDefaultToolkit().getDesktopProperty("win.propNames");

で、プロパティー一覧を取得しても、"win.messagebox.textColor" は存在しないので、 「メッセージボックスのフォントカラー」自体が設定できないのかもしれない。

他にも同様に、?がついて重複するプロパティー名が存在する。

「アイコンのサイズ」 "win.icon.hspacing" "win.icon.vspacing"???
「アイコンの横の間隔」 "win.icon.hspacing"
「アイコンの縦の間隔」 "win.icon.vspacing"

Dimension オブジェクト、寸法オブジェクト

• https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html#getSize--
  • a Dimension object
• https://docs.oracle.com/javase/jp/8/docs/api/java/awt/Component.html#getSize--
  • Dimension オブジェクト

• https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html#getPreferredSize--
  • a dimension object
• https://docs.oracle.com/javase/jp/8/docs/api/java/awt/Component.html#getPreferredSize--
  • 寸法オブジェクト

Component.AccessibleAWTComponent.getAccessibleIndexInParent()

• https://docs.oracle.com/javase/8/docs/api/javax/swing/SwingUtilities.html
  • Note: as of the Java 2 platform v1.3, it is recommended that developers call Component.AccessibleAWTComponent.getAccessibleIndexInParent() instead of using this method.

コピペして、修正し忘れてるようで、注:が全部getAccessibleIndexInParentのものと同じになっている。

1.8.0 で修正済み

Typo: agressively

• https://docs.oracle.com/javase/7/docs/api/javax/swing/UIManager.html
  • agressively
• 変更案
  • aggressively

• メモ1
  • Some look and feels may agressively look up defaults, so that changing a default may not have an effect after installing the look and feel. Other look and feels may lazily access defaults so that a change to the defaults may effect an existing look and feel.

この説明がよく分からない。逆のような気がするような、しないような…。

• メモ2
  • UIManager.getString("Table.foreground")

この例だと、色をgetStringで取得しようとしているので、常に null になる。UIManager.get("Table.foreground") とか UIManager.getColor("Table.foreground") にした方がよさそう。

class MyApp java.io.Serializable

• https://docs.oracle.com/javase/7/docs/api/java/awt/Component.html
  • class MyApp java.io.Serializable
• 変更案
  • class MyApp implements java.io.Serializable

サンプルコードで、implements が抜けている。

Java 9 で修正済み

Typo: any of of them

• https://docs.oracle.com/javase/8/docs/api/javax/swing/JLayer.html
  • using any of of them will cause UnsupportedOperationException to be thrown,
• 変更案
  • using any of them will cause UnsupportedOperationException to be thrown,

サンプルコードが一行になっている

• https://docs.oracle.com/javase/8/docs/api/java/awt/BasicStroke.html
  • // sets the Graphics2D object's Transform attirbute g2d.scale(10, 10); // sets the Graphics2D object's Storoke attribute g2d.setStroke(new BasicStroke(1.5f));

JSpinnerサンプルコード

• https://docs.oracle.com/javase/8/docs/api/javax/swing/JSpinner.html
  • JDK-5109918 Wrong documentation for JSpinner.DateEditor constructor - Java Bug System

• 余計な{がある。
  • catch (ParseException pe) {{

• ;が抜けている。
  • JComponent editor = spinner.getEditor()

• )が足りない。
  • ((DefaultEditor)editor).getTextField().setValue(spinner.getValue();

dataModelとnewModel

• https://docs.oracle.com/javase/8/docs/api/javax/swing/JTable.html#setModel-javax.swing.table.TableModel-
  • 引数のdataModelとnewModelが混ざっている？

public void setModel(TableModel dataModel)
このテーブルのデータモデルを newModel に設定し、それに新しいデータモデルからのリスナー通知を登録します。
パラメータ:
dataModel - このテーブルの新しいデータソース
例外:
IllegalArgumentException - newModel が null の場合

Htmlの表がずれている

• https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html#setFocusTraversalKeys-int-java.util.Set-
  • KeyboardFocusManager.DOWN_CYCLE_TRAVERSAL_KEYS, 1 つ下のフォーカストラバーサルサイクルに移動 none
• Bug ID: 4470006 Table shown for Traversal Keys in setDefaultFocusTraversalKeys() not proper
  • Submit Date 14-JUN-2001
• Container#setFocusTraversalKeys(...) (Java SE 9 & JDK 9)

setAlignmentX, setAlignmentY, getAlignmentX, getAlignmentY javadoc of JComponent

• JDK-8068374 setAlignmentX, setAlignmentY, getAlignmentX, getAlignmentY javadoc of JComponent - Java Bug System

水平と垂直が実際の動作と入れ替わっている。

DateTimeFormatter week-of-month

• JDK-8169482 java.time.DateTimeFormatter javadoc: F is not week-of-month - Java Bug System
• time - Java 8 DateFormatter week of month and year key symbols difference - Stack Overflow
• DateTimeFormatter (Java Platform SE 8)
• パターン文字のWとFが両方week-of-monthになっている
• 実際はFがday-of-week-in-month
• DateTimeFormatter (Java SE 9 & JDK 9)

コメント