Содержание | Предыдущий | Следующий | Индекс

ГЛАВА 18

Комментарии для документации


Программы Java могут включать документацию в свой исходный код в специальные комментарии для документации (§3.7). Такие комментарии могут появиться перед каждым классом или соединить интерфейсом с объявлением и перед каждым методом, конструктором, или полевым объявлением. Гипертекстовые веб-страницы могут тогда быть произведены автоматически из исходного кода программы и этих комментариев для документации.

Эта глава дает неофициальное описание комментариев для документации. Полная формальная спецификация потребовала бы подробного описания тех частей Языка разметки гипертекста (HTML), который может использоваться в пределах комментариев для документации, который выходит за рамки этой спецификации.

18.1 Текст Комментария для документации

Текст комментария для документации состоит из символов между /** это начинает комментарий и */ это заканчивает это. Текст делится на одну или более строк. На каждой из этих строк, ведя * символы игнорируются; для строк кроме первого, пробелов и вкладок, предшествующих начальной букве * символы также отбрасываются.

Так, например, в комментарии:


/**XYZ
  ** Initialize to pre-trial defaults.
  123*/
у текста комментария есть три строки. Первая строка состоит из текста"XYZ"; вторая строка состоит из текста" Initialize to pre-trial defaults."и третья строка состоит из текста"123"

18.2 HTML в Комментарии для документации

Текст в комментарии для документации может использовать маркеры HTML для того, чтобы отформатировать, за исключением того, что определенные маркеры <H1>, <H2>, <H3>, <H4>, <H5>, <H6>, и <HR> резервируются для использования генератором документации и не должен использоваться в тексте. Полное описание HTML доступно от веб-сайта http://www.w3.org и также через интернет-базу данных документации в http://www.internic.net, где документ "Язык разметки гипертекста - Версия 2.0" Т. Бернерсом-Ли и Д. Коннолли может быть найден как RFC1866.

18.3 Сводное Предложение и Общее Описание

Первое предложение каждого комментария для документации должно быть сводным предложением, содержа краткое, но полное описание объявленного объекта. Это предложение заканчивается в первый период, который сопровождается пробелом, вкладкой, или разделителем строки, или в первом tagline (как определено ниже). Это простое правило означает что первое предложение, такое как:

This is a simulation of Prof. Knuth's MIX computer.
не будет работать должным образом, потому что период после сокращения"Prof"заканчивает первое предложение, насколько процессор комментария для документации Java затрагивается. Заботьтесь, чтобы избежать таких трудностей.

Предложения после сводного предложения, но предшествования первому теговому абзацу (если кто-либо) являются общей частью описания комментария для документации.

18.4 Теговые Абзацы

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

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

Различные виды теговых абзацев доступны для класса и интерфейсных объявлений и для метода, поля, и объявлений конструктора.

18.4.1 @see Тег

Следующее является примерами @see абзацы, которые могут использоваться в любом комментарии для документации, чтобы указать на перекрестную ссылку на класс, интерфейс, метод, конструктора, поле, или URL:


@see java.lang.String
@see String
@see java.io.InputStream;
@see String#equals
@see java.lang.Object#wait(int)
@see java.io.RandomAccessFile#RandomAccessFile(File, String)
@see Character#MAX_RADIX
@see <a href="spec.html">Java Spec</a>
Символ # разделяет имя класса с имени одного из его полей, методов, или конструкторов. Один из нескольких перегруженных методов или конструкторов может быть выбран включением заключенного в скобки списка типов параметра после имени конструктора или метода.

Комментарий для документации может содержать больше чем один @see тег.

18.4.2 @author Тег

Следующее является примерами @author taglines, который может использоваться в комментариях для документации для класса и интерфейсных объявлений:


@author Mary Wollstonecraft
@author Hildegard von Bingen
@author Dorothy Parker
Информация в @author у абзаца нет никакой специальной внутренней структуры.

Комментарий для документации может содержать больше чем один @author тег. Альтернативно, сингл @author абзац может упомянуть несколько авторов:


@author Jack Kent, Peggy Parish, Crockett Johnson,
	James Marshall, Marjorie Weinman Sharmat,
	Robert McCloskey, and Madeleine L'Engle
Однако, мы рекомендуем определить одного автора на @author абзац, который позволяет инструменту обработки документации обеспечивать корректную пунктуацию при всех обстоятельствах.

18.4.3 @version Тег

Следующее является примером a @version абзац, который может использоваться в комментариях для документации для класса и интерфейсных объявлений:

@version 493.0.1beta
Информация в a @version у абзаца нет никакой специальной внутренней структуры.

Комментарий для документации может содержать самое большее один @version тег.

18.4.4 @param Тег

Следующее является примерами @param абзацы, которые могут использоваться в комментариях для документации для объявлений конструктора и метода:


@param file the file to be searched
@param pattern
	the pattern to be matched during the search
@param count      the number of lines to print for each match
Информация в a @param абзац должен состоять из имени параметра, сопровождаемого кратким описанием.

Комментарий для документации может содержать больше чем один @param тег. Обычное соглашение - это если любой @param абзацы присутствуют в комментарии для документации, тогда должен быть тот @param абзац для каждого параметра метода или конструктора, и @param абзацы должны появиться в порядке, в котором объявляются параметры.

18.4.5 @return Тег

Следующее является примером a @return абзац, который может использоваться в комментариях для документации для объявлений методов, тип результата которых не void:

@return the number of widgets that pass the quality test
Информация в a @return у абзаца нет никакой специальной внутренней структуры. Обычное соглашение состоит в том, что это состоит из краткого описания возвращенного значения.

Комментарий для документации может содержать самое большее один @return тег.

18.4.6 @exception Тег

Следующее является примером @exception абзац, который может использоваться в комментариях для документации для объявлений конструктора и метода:


@exception IndexOutOfBoundsException
				the matrix is too large
@exception UnflangedWidgetException the widget does not
				have a flange, or its flange has size zero
@exception java.io.FileNotFoundException the file
				does not exist
Информация в @exception абзац должен состоять из имени класса исключений (который может быть простым именем или полностью определенным именем), сопровождаемый кратким описанием обстоятельств, которые заставляют исключение быть брошенным.

Комментарий для документации может содержать больше чем один @exception тег.

18.5 Пример

Здесь, как пример, версия исходного кода для класса Object из пакета java.lang, включая его комментарии для документации.


/*
 * @(#)Object.java 1.37 96/06/26
 *
 * Copyright (c) 1994, 1995, 1996 Sun Microsystems, Inc.
 * All Rights Reserved.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for NON-COMMERCIAL purposes
 * and without fee is hereby granted provided that this
 * copyright notice appears in all copies. Please refer to
 * the file "copyright.html" for further important copyright
 * and licensing information.
 *
 * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE
 * SUITABILITY OF THE SOFTWARE, EITHER EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
 * NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR ANY DAMAGES
 * SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.
 */


package java.lang;
/** * The root of the Class hierarchy. Every Class in the * system has Object as its ultimate parent. Every variable * and method defined here is available in every Object. * @see Class * @version 1.37, 26 Jun 1996 */
public class Object { /** * Returns the Class of this Object. Java has a runtime * representation for classes--a descriptor of type Class * --which the method getClass() returns for any Object. */ public final native Class getClass();
/** * Returns a hashcode for this Object. * Each Object in the Java system has a hashcode. * The hashcode is a number that is usually different * for different Objects. It is used when storing Objects * in hashtables. * Note: hashcodes can be negative as well as positive. * @see java.util.Hashtable */ public native int hashCode();
/** * Compares two Objects for equality. * Returns a boolean that indicates whether this Object * is equivalent to the specified Object. This method is * used when an Object is stored in a hashtable. * @param obj the Object to compare with * @return true if these Objects are equal; * false otherwise. * @see java.util.Hashtable */ public boolean equals(Object obj) { return (this == obj); }
/** * Creates a clone of the object. A new instance is * allocated and a bitwise clone of the current object * is placed in the new object. * @return a clone of this Object. * @exception OutOfMemoryError If there is not enough * memory. * @exception CloneNotSupportedException Object * explicitly does not want to be * cloned, or it does not support * the Cloneable interface. */ protected native Object clone() throws CloneNotSupportedException;


	/**
	 * Returns a String that represents this Object.
	 * It is recommended that all subclasses override
	 * this method.
	 */
	public String toString() {
		return getClass().getName() + "@" +
			Integer.toHexString(hashCode());
	}

/** * Notifies a single waiting thread on a change in * condition of another thread. The thread effecting * the change notifies the waiting thread using notify(). * Threads that want to wait for a condition to change * before proceeding can call wait(). <p> * <em>The method notify() can be called only by the * thread that is the owner of the current object's * monitor lock.</em> * * @exception IllegalMonitorStateException If the * current thread is not the owner * of the Object's monitor lock. * @see Object#wait * @see Object#notifyAll */ public final native void notify();
/** * Notifies all the threads waiting for a condition to * change. Threads that are waiting are generally waiting * for another thread to change some condition. Thus, the * thread effecting a change that more than one thread is * waiting for notifies all the waiting threads using * the method notifyAll(). Threads that want to wait for * a condition to change before proceeding can call * wait(). <p> * <em>The method notifyAll() can be called only by the * thread that is the owner of the current object's * monitor lock.</em> * * @exception IllegalMonitorStateException If the * current thread is not the owner * of the Object's monitor lock. * @see Object#wait * @see Object#notify */ public final native void notifyAll();

	/**
	 * Causes a thread to wait until it is notified or the
	 * specified timeout expires. <p>
	 * <em>The method wait(millis) can be called only by
	 * the thread that is the owner of the current object's
	 * monitor lock.</em>
	 *
	 * @param 				millis			the maximum time to wait,
	 * 								in milliseconds
	 * @exception					IllegalMonitorStateException If the
	 * 						current thread is not the owner
	 * 						of the Object's monitor lock.
	 * @exception 					InterruptedException Another thread has
	 * 						interrupted this thread. 
	 */
	public final native void wait(long millis)
		throws InterruptedException;

/** * More accurate wait. * <em>The method wait(millis, nanos) can be called only * by the thread that is the owner of the current * object's monitor lock.</em> * * @param millis the maximum time to wait, * in milliseconds * @param nano additional time to wait, * in nanoseconds * (range 0-999999) * @exception IllegalMonitorStateException If the * current thread is not the owner * of the Object's monitor lock. * @exception InterruptedException Another thread has * interrupted this thread. */ public final void wait(long millis, int nanos) throws InterruptedException { if (nanos >= 500000 || (nanos != 0 && millis==0)) timeout++; wait(timeout); }
/** * Causes a thread to wait forever until it is notified. * <p> * <em>The method wait() can be called only by the * thread that is the owner of the current object's * monitor lock.</em> *
	 * @exception					IllegalMonitorStateException If the
	 * 						current thread is not the owner
	 * 						of the Object's monitor lock.
	 * @exception 					InterruptedException Another thread has
	 * 						interrupted this thread. 
	 */
	public final void wait() throws InterruptedException {
		wait(0);
	}


	/**
	 * Code to perform when this object is garbage collected.
	 * The default is that nothing needs to be performed.
	 * 
	 * Any exception thrown by a finalize method causes the
	 * finalization to halt.  But otherwise, it is ignored.
	 */
	protected void finalize() throws Throwable { }

}
Из этого исходного кода, javadoc инструмент, произведенный следующий файл HTML, который доступен для просмотра в http://java.sun.com/Series, наш Серийный веб-сайт Java:

<! - NewPage->

<html>

<голова>

<! - Сгенерированный javadoc на Wed 26 июня EDT 11:40:38 1996->

<имя = "_ вершина _"> </a>

<заголовок>

Класс java.lang. Объект

</заголовок>

</голова>

<тело>

<пред>

<href = "packages.html"> Все Пакеты </a> <href = "tree.html"> Класс Hierarchy¬
</a> <href = "Package-java.lang.html"> Этот Пакет </a> <href = "java.lang. N¬
umber.html#_top_"> Предыдущий </a> <href = "java.lang.OutOfMemoryError.html#_top¬
_ "> Затем </a> <href = "AllNames.html"> Индекс </a> </пред>

<час>

<h1>

Класс java.lang. Объект

</h1>

<пред>

java.lang. Объект

</пред>

<час>

<dl>

<dt> Объект класса <b> общественности </b>

</dl>

Корень Иерархии классов. Каждый Класс в

у системы есть Объект как его окончательный родитель. Каждая переменная

и метод, определенный здесь, доступен в каждом Объекте.

<dl>

<dt> <b> Версия: </b>

<dd> 1.37, 26 июня 1996

<dt> <b> Видят Также: </b>

<dd> <href = "java.lang.Class.html#_top_"> Класс </a>

</dl>

<час>

<имя = "индекс"> </a>

<h2>

<img src = "images/constructor-index.gif" width=275 height=38 высокий звук = "Constructo¬
r Индекс">

</h2>

<dl>

<dt> <img src = "images/yellow-ball-small.gif" width=6 height=6 высокий звук =" o">

<href = "#Object ()"> <b> Объект </b> </a> ()

<dd>

</dl>

<h2>

<img src = "images/method-index.gif" width=207 height=38 высокий звук = "Индекс Метода">

</h2>

<dl>

<dt> <img src = "images/red-ball-small.gif" width=6 height=6 высокий звук =" o">

<href = "#clone ()"> <b> клон </b> </a> ()

<dd> Создает клона объекта.

<dt> <img src = "images/red-ball-small.gif" width=6 height=6 высокий звук =" o">

<href = "#equals (java.lang. Объект)",> <b> равняется </b> </a> (Объект)

<dd> Сравнивает два Объекта для равенства.

<dt> <img src = "images/red-ball-small.gif" width=6 height=6 высокий звук =" o">

<href = "#finalize ()"> <b> завершают </b> </a> ()

Код <dd>, чтобы выполнить, когда этот объект собирается "мусор".

<dt> <img src = "images/red-ball-small.gif" width=6 height=6 высокий звук =" o">

<href = "#getClass ()"> <b> getClass </b> </a> ()

<dd> Возвраты Класс этого Объекта.

<dt> <img src = "images/red-ball-small.gif" width=6 height=6 высокий звук =" o">

<href = "#hashCode ()"> <b> хэш-код </b> </a> ()

<dd> Возвраты хэш-код для этого Объекта.

<dt> <img src = "images/red-ball-small.gif" width=6 height=6 высокий звук =" o">

<href = "#notify ()"> <b> уведомляют </b> </a> ()

<dd> Уведомляет единственный поток ожидания относительно изменения в

условие другого потока.

<dt> <img src = "images/red-ball-small.gif" width=6 height=6 высокий звук =" o">

<href = "#notifyAll ()"> <b> notifyAll </b> </a> ()

<dd> Уведомляет все потоки, ожидающие условия к

изменение.

<dt> <img src = "images/red-ball-small.gif" width=6 height=6 высокий звук =" o">

<href = "#toString ()"> <b> toString </b> </a> ()

Возвраты <dd> Строка, которая представляет этот Объект.

<dt> <img src = "images/red-ball-small.gif" width=6 height=6 высокий звук =" o">

<href = "#wait ()"> <b> ожидают </b> </a> ()

Причины <dd> поток, чтобы ожидать навсегда, пока это не уведомляется.

<dt> <img src = "images/red-ball-small.gif" width=6 height=6 высокий звук =" o">

<href = "#wait (долго)"> <b> ожидают </b> </a> (долго)

Причины <dd> поток, чтобы ожидать, пока это не уведомляется или

указанный тайм-аут истекает.

<dt> <img src = "images/red-ball-small.gif" width=6 height=6 высокий звук =" o">

<href = "#wait (долго, интервал)"> <b> ожидают </b> </a> (долго, интервал)

Ожидают более точные <dd>.

</dl>

<имя = "конструкторы"> </a>

<h2>

<img src = "images/constructors.gif" width=231 height=38 высокий звук = "Конструкторы">

</h2>

<имя = "Объект"> </a>

<имя = "Объект ()"> <img src = "images/yellow-ball.gif" width=12 height=12 высокий звук = "¬
o"> </a>

<b> Объект </b>

<пред>

общедоступный Объект ()

</пред>

<имя = "методы"> </a>

<h2>

<img src = "images/methods.gif" width=151 height=38 высокий звук = "Методы">

</h2>

<имя = "getClass ()"> <img src = "images/red-ball.gif" width=12 height=12 высокий звук =" ¬
o"> </a>

<имя = "getClass"> <b> getClass </b> </a>

<пред>

общедоступный финал <href = "java.lang.Class.html#_top_"> Класс </a> getClass ()

</пред>

<dl>

<dd> Возвраты Класс этого Объекта. У Java есть время выполнения

представление для классов - дескриптор Класса типа

- который метод getClass () возвращает для любого Объекта.

</dl>

<имя = "хэш-код ()"> <img src = "images/red-ball.gif" width=12 height=12 высокий звук =" ¬
o"> </a>

<имя = "хэш-код"> <b> хэш-код </b> </a>

<пред>

общедоступный международный хэш-код ()

</пред>

<dl>

<dd> Возвраты хэш-код для этого Объекта.

У каждого Объекта в системе Java есть хэш-код.

Хэш-код является числом, которое обычно отличается

для различных Объектов. Это используется, храня Объекты

в хеш-таблицах.

Отметьте: хэш-коды могут быть отрицательными так же как положительными.

<dl>

<dt> <b> Видят Также: </b>

<dd> <href = "java.util.Hashtable.html#_top_"> Хеш-таблица </a>

</dl>

</dl>

<имя = "равняется (java.lang. Объект)"> <img src = "images/red-ball.gif" width=12 he¬
высокий звук ight=12 =" o"> </a>

<имя = "равняется"> <b>, равняется </b> </a>

<пред>

общедоступная булевская переменная равняется (<href = "#_top_"> Объект </a> obj)

</пред>

<dl>

<dd> Сравнивает два Объекта для равенства.

Возвращает булевскую переменную, которая указывает ли этот Объект

эквивалентно указанному Объекту. Этот метод

используемый, когда Объект хранится в хеш-таблице.

<dl>

<dt> <b> Параметры: </b>

<dd> obj - Объект сравниться с

<dt> <b> Возвраты: </b>

истина <dd>, если эти Объекты равны;

ложь иначе.

<dt> <b> Видят Также: </b>

<dd> <href = "java.util.Hashtable.html#_top_"> Хеш-таблица </a>

</dl>

</dl>

<имя = "клон ()"> <img src = "images/red-ball.gif" width=12 height=12 высокий звук =" o "¬
> </a>

<имя = "клон"> <b> клон </b> </a>

<пред>

защищенный <href = "#_top_"> Объект </a> клон () броски <href = "java.lang. Clo¬
neNotSupportedException.html#_top_"> CloneNotSupportedException </a>

</пред>

<dl>

<dd> Создает клона объекта. Новый экземпляр

выделенный и поразрядный клон текущего объекта

помещается в новый объект.

<dl>

<dt> <b> Возвраты: </b>

<dd> клон этого Объекта.

<dt> <b> Броски: </b> <href = "java.lang.OutOfMemoryError.html#_top_"> OutOf¬
MemoryError </a>

<dd>, Если есть недостаточно

память.

<dt> <b> Броски: </b> <href = "java.lang.CloneNotSupportedException.html#_t¬
op _ "> CloneNotSupportedException </a>

<dd> Объект

явно не хочет быть

клонированный, или это не поддерживает

интерфейс Cloneable.

</dl>

</dl>

<имя = "toString ()"> <img src = "images/red-ball.gif" width=12 height=12 высокий звук =" ¬
o"> </a>

<имя = "toString"> <b> toString </b> </a>

<пред>

общественность <href = "java.lang.String.html#_top_"> Строка </a> toString ()

</пред>

<dl>

Возвраты <dd> Строка, которая представляет этот Объект.

Рекомендуется, чтобы все подклассы переопределили

этот метод.

</dl>

<имя = "уведомляют ()"> <img src = "images/red-ball.gif" width=12 height=12 высокий звук =" o ¬
"> </a>

<имя = "уведомляет"> <b>, уведомляют </b> </a>

<пред>

общедоступный финал пусто уведомляет ()

</пред>

<dl>

<dd> Уведомляет единственный поток ожидания относительно изменения в

условие другого потока. Осуществление потока

изменение уведомляет, что использование потока ожидания уведомляет ().

Потоки, которые хотят ожидать условия измениться

прежде, чем продолжение может вызвать, ожидают (). <p>

<их> метод уведомляет (), может быть вызван только

поток, который является владельцем текущего объекта

блокировка монитора. </em>

<dl>

<dt> <b> Броски: </b> <href = "java.lang.IllegalMonitorStateException.html#¬
_top _ "> IllegalMonitorStateException </a>

<dd>, Если

текущий поток не является владельцем

из блокировки монитора Объекта.

<dt> <b> Видят Также: </b>

<dd> <href = "#wait"> ожидают </a>, <href = "#notifyAll"> notifyAll </a>

</dl>

</dl>

<имя = "notifyAll ()"> <img src = "images/red-ball.gif" width=12 height=12 высокий звук = "¬
o"> </a>

<имя = "notifyAll"> <b> notifyAll </b> </a>

<пред>

общедоступный финал освобождает notifyAll ()

</пред>

<dl>

<dd> Уведомляет все потоки, ожидающие условия к

изменение. Потоки, которые ожидают, обычно ожидают

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

поток, вызывающий изменение, которое больше чем один поток

ожидание уведомляет, что все ожидание распараллеливает использование

метод notifyAll (). Потоки, которые хотят ожидать

условие измениться перед продолжением может вызвать

ожидайте (). <p>

<их> метод notifyAll () можно вызвать только

поток, который является владельцем текущего объекта

блокировка монитора. </em>

<dl>

<dt> <b> Броски: </b> <href = "java.lang.IllegalMonitorStateException.html#¬
_top _ "> IllegalMonitorStateException </a>

<dd>, Если

текущий поток не является владельцем

из блокировки монитора Объекта.

<dt> <b> Видят Также: </b>

<dd> <href = "#wait"> ожидает </a>, <href = "#notify"> уведомляет </a>

</dl>

</dl>

<имя = "ожидают (долго)"> <img src = "images/red-ball.gif" width=12 height=12 высокий звук =" ¬
o"> </a>

<имя = "ожидает"> <b>, ожидают </b> </a>

<пред>

общедоступный финал пусто ожидает (долго millis) броски <href = "java.lang. InterruptedEx¬
ception.html#_top_"> InterruptedException </a>

</пред>

<dl>

Причины <dd> поток, чтобы ожидать, пока это не уведомляется или

указанный тайм-аут истекает. <p>

<их> метод ожидает (millis), можно вызвать только

поток, который является владельцем текущего объекта

блокировка монитора. </em>

<dl>

<dt> <b> Параметры: </b>

<dd> millis - максимальное время, чтобы ожидать,

в миллисекундах

<dt> <b> Броски: </b> <href = "java.lang.IllegalMonitorStateException.html#¬
_top _ "> IllegalMonitorStateException </a>

<dd>, Если

текущий поток не является владельцем

из блокировки монитора Объекта.

<dt> <b> Броски: </b> <href = "java.lang.InterruptedException.html#_top_"> I¬
nterruptedException </a>

<dd> Другой поток имеет

прерванный этот поток.

</dl>

</dl>

<имя = "ожидают (долго, интервал)"> <img src = "images/red-ball.gif" width=12 height=12 a¬
лейтенант =" o"> </a>

<имя = "ожидает"> <b>, ожидают </b> </a>

<пред>

общедоступный финал пусто ожидает (долго millis,

интервал nanos) броски <href = "java.lang. InterruptedExce¬
ption.html#_top_"> InterruptedException </a>

</пред>

<dl>

Ожидают более точные <dd>.

<их> метод ожидает (millis, nanos) может быть вызван только

потоком, который является владельцем тока

блокировка монитора объекта. </em>

<dl>

<dt> <b> Параметры: </b>

<dd> millis - максимальное время, чтобы ожидать,

в миллисекундах

<dd> nano - дополнительное время, чтобы ожидать,

в наносекундах

(расположитесь 0-999999),

<dt> <b> Броски: </b> <href = "java.lang.IllegalMonitorStateException.html#¬
_top _ "> IllegalMonitorStateException </a>

<dd>, Если

текущий поток не является владельцем

из блокировки монитора Объекта.

<dt> <b> Броски: </b> <href = "java.lang.InterruptedException.html#_top_"> I¬
nterruptedException </a>

<dd> Другой поток имеет

прерванный этот поток.

</dl>

</dl>

<имя = "ожидают ()"> <img src = "images/red-ball.gif" width=12 height=12 высокий звук =" o"> ¬
</a>

<имя = "ожидает"> <b>, ожидают </b> </a>

<пред>

общедоступный финал пусто ожидает () броски <href = "java.lang. InterruptedException.htm¬
l#_top_"> InterruptedException </a>

</пред>

<dl>

Причины <dd> поток, чтобы ожидать навсегда, пока это не уведомляется.

<p>

<их> метод ожидает (), может быть вызван только

поток, который является владельцем текущего объекта

блокировка монитора. </em>

<dl>

<dt> <b> Броски: </b> <href = "java.lang.IllegalMonitorStateException.html#¬
_top _ "> IllegalMonitorStateException </a>

<dd>, Если

текущий поток не является владельцем

из блокировки монитора Объекта.

<dt> <b> Броски: </b> <href = "java.lang.InterruptedException.html#_top_"> I¬
nterruptedException </a>

<dd> Другой поток имеет

прерванный этот поток.

</dl>

</dl>

<имя = "завершают ()"> <img src = "images/red-ball.gif" width=12 height=12 высокий звук =" ¬
o"> </a>

<имя = "завершает"> <b>, завершают </b> </a>

<пред>

защищенный пусто завершают () броски <href = "java.lang.Throwable.html#_top_"> T¬
hrowable </a>

</пред>

<dl>

Код <dd>, чтобы выполнить, когда этот объект собирается "мусор".

Значение по умолчанию - то, что ничто не должно быть выполнено.

Любое исключение, выданное завершить методом, вызывает

завершение, чтобы остановиться. Но иначе, это игнорируется.

</dl>

<час>

<пред>

<href = "packages.html"> Все Пакеты </a> <href = "tree.html"> Класс Hierarchy¬
</a> <href = "Package-java.lang.html"> Этот Пакет </a> <href = "java.lang. N¬
umber.html#_top_"> Предыдущий </a> <href = "java.lang.OutOfMemoryError.html#_top¬
_ "> Затем </a> <href = "AllNames.html"> Индекс </a> </пред>

</тело>

</HTML>

Многие из строк в этом файле HTML являются слишком длинными, чтобы соответствовать на эти страницы. Мы использовали символ"¬"в конце строки, чтобы указать, что следующая строка текста на странице является частью той же самой строки в сгенерированном файле.

Этот сгенерированный файл HTML предназначается только как пример, не как спецификация поведения javadoc инструмент, который может быть изменен в течение долгого времени, чтобы улучшить представление HTML информации о документации.


Содержание | Предыдущий | Следующий | Индекс

Спецификация языка Java (HTML, сгенерированный Блинчиком "сюзет" Pelouch 24 февраля 1998)
Авторское право © Sun Microsystems, Inc 1996 года. Все права защищены
Пожалуйста, отправьте любые комментарии или исправления к doug.kramer@sun.com



Spec-Zone.ru - all specs in one place



free hit counter