Раздел «Использование Javadoc» — почему он отсутствует?

В javadocs некоторые API (вне java.lang и java.util) "Использовать" отсутствует.

Например, XMLStreamReader. Немного неприятно, что вы не можете сказать, какие классы API возвращают нужный вам класс, на основе javadoc, и вы должны использовать некоторые другие приемы (например, функции IDE), чтобы сделать это.

Есть ли причина не включать раздел «Использование» в эти API?


person Bozho    schedule 22.01.2010    source источник


Ответы (2)


Ссылка, которую вы разместили для XMLStreamReader, была для javadocs в разделе http://java.sun.com/webservice, а не для основного API JavaSE.

Документ Javadoc для XMLStreamReader в Однако в core javadoc раздел «Использование» полностью заполнен.

Что касается того, почему они разные, я подозреваю, что это просто проблема контроля качества.

person skaffman    schedule 23.01.2010

Такие классы, как javax.xml.stream.XMLStreamReader, являются частью расширения Java., поэтому их можно заменить конкретными реализациями (в данном случае, если я правильно помню, реализация налог).

Вы должны получить фактический класс службы с помощью фабричного метода, используя два общедоступных класса XMLInputFactory и XMLOutputFactory. По замыслу вам не нужно знать, что такое реальный реализующий класс.

EDIT: ссылка, которую вы предоставили для XMLStreamReader, взята из пакета веб-служб для java 1.5. Я не знаю, почему отсутствует раздел использования, но как бы там ни было, в java se 6 API он включен (см. здесь). Надеюсь это поможет ...

person Yoni    schedule 22.01.2010
comment
Да, но использование внутри API особенно полезно. Раздел «См. также» часто полезен, но не всегда. И XMLStreamReader является частью классов boostrap — он находится в rt.jar - person Bozho; 22.01.2010
comment
не могли бы вы дать ссылку с примером? Возможно, я неправильно понял, о каком использовании вы говорите. - person Yoni; 23.01.2010