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

Question

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

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

Есть ли причина не включать раздел "Использование" в эти API-интерфейсы?

Answer 1

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

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

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

Answer 2

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

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

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