javax.servlet.jsp.tagext
Класс BodyContent

java.lang.Object
  |
  +--java.io.Writer
        |
        +--javax.servlet.jsp.JspWriter
              |
              +--javax.servlet.jsp.tagext.BodyContent

public abstract class BodyContent

extends JspWriter

Инкапсуляция обсчёта тела акции так, что она (акция) становится доступной для обработчика тэга. BodyContent является подклассом JspWriter'а.

Обратите внимание, что содержимое BodyContent'а является результатом вычисления, поэтому будет содержать не акции или что-либо подобное, а результат их вызовов.

BodyContent имеет методы для конвертации своего содержимого в String, чтобы читать его содержимое, и для зачистки содержимого.

Размер буфера BodyContent-объекта не ограничен. BodyContent-объект не может находиться в режиме autoFlush. невозможно вызвать flush в BodyContent-объекте, так как отсутствует фоновый/backing поток.

Экземпляры BodyContent'а создаются путём вызова методов pushBody и popBody класса PageContext. BodyContent содержится внутри другого JspWriter (может быть, другого BodyContent-объекта), следующего в структуре их ассоциированных акций.

BodyContent становится доступным BodyTag'у через вызов setBodyContent(). Обработчик тэга может использовать этот объект/object до момента после вызова doEndTag().

Поля, унаследованные из класса javax.servlet.jsp.JspWriter

autoFlush, bufferSize, DEFAULT_BUFFER, NO_BUFFER, UNBOUNDED_BUFFER

 

Поля, унаследованные из класса java.io.Writer

lock

 

Конструктор. Резюме.
protected	BodyContent (JspWriter e)           Protected-конструктор.

 

Метод. Резюме.
void	clearBody ()           Зачищает тело/body без вызова исключений.
void	flush ()           Переопределил flush(), поэтому это недопустимо.
JspWriter	getEnclosingWriter ()           Получает содержащий JspWriter.
abstract  java.io.Reader	getReader ()           Возвращает значение данного BodyContent'а как Reader.
abstract  java.lang.String	getString ()           Возвращает значение BodyContent'а как String.
abstract  void	writeOut (java.io.Writer out)           Записывает содержимое данного BodyContent'а в Writer.

 

Методы, унаследованные из класса javax.servlet.jsp.JspWriter

clear, clearBuffer, close, getBufferSize, getRemaining, isAutoFlush, newLine, print, print, print, print, print, print, print, print, print, println, println, println, println, println, println, println, println, println, println

 

Методы, унаследованные из класса java.io.Writer

write, write, write, write, write

 

Методы, унаследованные из класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Конструктор. Детали.

BodyContent

protected BodyContent(JspWriter e)

Protected-конструктор. Неограниченный буфер, нет autoflushing'а.

flush

public void flush()
           throws java.io.IOException

Переопределил flush(), поэтому это недопустимо.

Недопустимо очищать BodyContent, поскольку позади него нет фонового потока.

Переопределяет:

flush в классе JspWriter.

clearBody

public void clearBody()

Очищает тело без вызова исключений.

getReader

public abstract java.io.Reader getReader()

Возвращает значение данного BodyContent'а как Reader.

Возвращает:

значение данного BodyContent'а как Reader.

getString

public abstract java.lang.String getString()

Возвращает значение данного BodyContent'а как String.

Возвращает:

значение данного BodyContent'а как String.

writeOut

public abstract void writeOut(java.io.Writer out)
                       throws java.io.IOException

Записывает содержимое данного BodyContent'а в Writer. Подклассы могут оптимизировать патэрны обычного вызова.

Параметры:

out - writer, в который помещается содержимое данного вычисления тела.

getEnclosingWriter

public JspWriter getEnclosingWriter()

Получает содержащий JspWriter.

Возвращает:

содержащий JspWriter, переданный на этапе конструирования.

javax.servlet.jsp.tagext
Интерфейс BodyTag

Все Известные Реализующие Классы:

BodyTagSupport

public abstract interface BodyTag

extends IterationTag

Интерфейс BodyTag расширяет IterationTag путём определения дополнительных методов, которые дают обработчику тэга возможность манипулировать содержимым, вычисляя его тело.

Обработчик тэга отвечает за манипуляции с содержимым тела. Например, обработчик тэга может взять содержимое тела, конвертировать его в String с помощью метода bodyContent.getString и затем использовать его (содержимое). Ил обработчик тэга может взять содержимое тела и записать его в содержащий JspWriter, используя метод bodyContent.writeOut.

Обработчик тэга, реализующий BodyTag, рассматривается как обработчик, реализующий IterationTag, за исключением того, что метод doStartTag может возвратить SKIP_BODY, EVAL_BODY_INCLUDE или EVAL_BODY_BUFFERED.

Если возвращено EVAL_BODY_INCLUDE, вычисление происходит, как в IterationTag.

Если возвращено EVAL_BODY_BUFFERED, будет создан BodyContent-объект (кодом, сгенерированным JSP-компилятором) для захвата вычисления тела. Код, сгенерированный JSP-компилятором, получает BodyContent-объект с помощью вызова метода pushBody текущего pageContext'а, который дополнительно сохраняет предыдущее значение out. Компилятор страницы возвращает этот объект через вызов метода popBody класса PageContext; этот вызов также восстанавливает значение out.

Этот интерфейс предоставляет одно новое свойство с setter-методом один новый метод акции.

Свойства

Имеется новое свойство, bodyContent, для получения BodyContent-объекта, в котором объект реализации JSP-страницы будет размещать результат вычисления (и повторного вычисления, если нужно) тела. Setter-метод (setBodyContent) будет вызываться только в том случае, если doStartTag() возвращает EVAL_BODY_BUFFERED.

Методы

В дополнение к setter-методу для свойства bodyContent имеется новый метод акции: doInitBody(), который вызывается сразу после setBodyContent() и перед вычислением тела. Этот метод будет вызываться только в том случае, если doStartTag() возвращает EVAL_BODY_BUFFERED.

Жизненный цикл

Детали жизненного цикла показаны на диаграмме переноса. Исключения, вызываемые при вычислении doStartTag(), setBodyContent(), doInitBody(), BODY, doAfterBody(), прерывают выполнение и помещаются на верх стэка, если только обработчик тэга не реализует интерфейс TryCatchFinally; см. детали об этом интерфейсе.

Пустая и Непустая Акция

Если TagLibraryDescriptor-файл указывает, что акция обязана всегда иметь пустую акцию, через вхождение <body-content> - "empty", то метод doStartTag() обязан возвратить SKIP_BODY. В ином случае, метод doStartTag() может возвратить SKIP_BODY, EVAL_BODY_INCLUDE или EVAL_BODY_BUFFERED.

Если возвращено SKIP_BODY, тело не вычисляется и вызывается doEndTag().

Если возвращено EVAL_BODY_INCLUDE, setBodyContent() не вызывается, doInitBody() не вызывается, тело вычисляется и "передаётся/passed through" текущему out, doAfterBody() вызывается, а затем, после 0 или более итераций, вызывается doEndTag().

Если возвращено EVAL_BODY_BUFFERED, вызывается setBodyContent(), вызывается doInitBody(), тело вычисляется, вызывается doAfterBody(), а затем, после 0 или более итераций, вызывается doEndTag().

Поле. Резюме.
static int	EVAL_BODY_BUFFERED           Запрашивается создание нового буфера, BodyContent, в котором вычисляется тело этого тэга.
static int	EVAL_BODY_TAG           Не рекомендуется. Как и в Java JSP API 1.2, использовать BodyTag.EVAL_BODY_BUFFERED или IterationTag.EVAL_BODY_AGAIN.

 

Поля, унаследованные из класса javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

 

Поля, унаследованные из класса javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

 

Метод. Резюме.
void	doInitBody ()           Подготавливает вычисление тела.
void	setBodyContent (BodyContent b)           Устанавливает свойство bodyContent.

 

Методы, унаследованные из интерфейса javax.servlet.jsp.tagext.IterationTag

doAfterBody

 

Методы, унаследованные из интерфейса javax.servlet.jsp.tagext.Tag

doEndTag, doStartTag, getParent, release, setPageContext, setParent

 

Поле. Детали.

EVAL_BODY_TAG

public static final int EVAL_BODY_TAG

Не рекомендуется. Как и в Java JSP API 1.2, использовать BodyTag.EVAL_BODY_BUFFERED или IterationTag.EVAL_BODY_AGAIN.

Не рекомендуемая для использования константа, которая имеет то же самое значение, что и EVAL_BODY_BUFFERED и EVAL_BODY_AGAIN. Это имя отмечено как не рекомендуемое для поощрения использования двух новых терминов, которые являются более описательными.

EVAL_BODY_BUFFERED

public static final int EVAL_BODY_BUFFERED

Запрашивает создание нового буфера, BodyContent, в котором вычисляется тело данного тэга. Возвращено из doStartTag, если он реализует BodyTag. Для doStartTag будет недопустимым return-занчением, если класс не реализует BodyTag.

setBodyContent

public void setBodyContent(BodyContent b)

Устанавливает свойство bodyContent. Этот метод вызывается объектом реализации JSP-страницы не более одного раза на каждый вызов акции. Этот метод вызывается до doInitBody. Этот метод не будет вызываться для пустых тэгов или непустых тэгов, чей метод doStartTag() возвращает SKIP_BODY или EVAL_BODY_INCLUDE.

Если setBodyContent вызывается, значение неявного объекта out уже было изменено в pageContext-объекте. Передаваемый BodyContent-объект не будет содержать в себе данных, но может быть использован повторно (и зачищен) после некоторого предыдущего вызова.

BodyContent-объект является доступным и имеет соответствующее содержимое до момента сразу после вызова метода doEndTag - в этом случае он может быть снова использован повторно.

Параметры:

b - BodyContent

doInitBody

public void doInitBody()
                throws JspException

Подготавливает вычисление тела. Этот метод вызывается объектом реализации JSP-страницы после setBodyContent и до первого вычисления тела. Этот метод не будет вызываться для пустых тэгов или непустых тэгов, чей метод doStartTag() возвращает SKIP_BODY или EVAL_BODY_INCLUDE.

JSP-контейнер будет ресинхронизировать любые значения переменных, которые обозначены как таковые в TagExtraInfo, после вызова doInitBody().

Вызывает:

JspException

javax.servlet.jsp.tagext
Класс BodyTagSupport

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--javax.servlet.jsp.tagext.BodyTagSupport

public class BodyTagSupport

extends TagSupport

implements BodyTag

Базовый класс для определения обработчиков тэгов, реализующих BodyTag.

Класс BodyTagSupport реализует интерфейс BodyTag и добавляет несколько удобных методов, включая getter-методы для свойства bodyContent и методы для получения предыдущего out JspWriter.

Многие обработчики тэгов расширяют BodyTagSupport и лишь переопределяют несколько методы.

См. также:

Сериализованная Форма

Поле. Резюме.
protected  BodyContent	bodyContent

 

Поля, унаследованные из класса javax.servlet.jsp.tagext.TagSupport

id, pageContext

 

Конструктор. Резюме.

BodyTagSupport ()           Конструктор по умолчанию, все подклассы должны только определить public-конструктор с той же подписью и вызвать конструктор суперкласса.

 

Метод. Резюме.
int	doAfterBody ()           После обсчёта тела: повторно не вычислять и продолжать обсчёт страницы.
int	doEndTag ()           Процессинг по умолчанию конечного тэга, возвращающего EVAL_PAGE.
void	doInitBody ()           Подготавливает к вычислению тела сразу перед первым вычислением тела: нет акции.
int	doStartTag ()           Процессинг по умолчанию начального тэга, возвращающего EVAL_BODY_BUFFERED.
BodyContent	getBodyContent ()           Получить текущий bodyContent.
JspWriter	getPreviousOut ()           Получить окружающий (содержащий) out JspWriter.
void	release ()           Освободить статус.
void	setBodyContent (BodyContent b)           Подготавливает к вычислению тела: берёт bodyContent.

 

Методы, унаследованные из класса javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

 

Методы, унаследованные из класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Поле. Детали.

bodyContent

protected BodyContent bodyContent

BodyTagSupport

public BodyTagSupport()

Конструктор по умолчанию, все подклассы должны только определить public-конструктор с той же подписью и вызвать конструктор суперкласса. Этот конструктор вызывается кодом, генерируемым JSP-транслятором.

doStartTag

public int doStartTag()
               throws JspException

Процессинг по умолчанию начального тэга, возвращающего EVAL_BODY_BUFFERED.

Возвращает:

EVAL_BODY_BUFFERED

Переопределяет:

doStartTag в классе TagSupport

doEndTag

public int doEndTag()
             throws JspException

Процессинг по умолчанию конечного тэга, возвращающего EVAL_PAGE.

Возвращает:

EVAL_PAGE

Переопределяет:

doEndTag в классе TagSupport

setBodyContent

public void setBodyContent(BodyContent b)

Подготавливает для вычисления тела: берёт bodyContent.

Специфицирован в:

setBodyContent в интерфейсе BodyTag.

Параметры:

b - BodyContent

doInitBody

public void doInitBody()
                throws JspException

Подготавливает для вычисления тела сразу перед первым вычислением тела: нет акции.

Специфицирован в:

doInitBody в интерфейсе BodyTag

doAfterBody

public int doAfterBody()
                throws JspException

После обсчёта тела: повторно не вычислять и продолжать обсчёт страницы. По умолчанию ничего не делается с данными bodyContent'а (если имеются).

Возвращает:

SKIP_BODY

Переопределяет:

doAfterBody в классе TagSupport

release

public void release()

Освободить статус.

Переопределяет:

release в классе TagSupport

getBodyContent

public BodyContent getBodyContent()

Получить текущий bodyContent.

Возвращает:

содержимое тела.

getPreviousOut

public JspWriter getPreviousOut()

Получить окружающий out JspWriter.

Возвращает:

содержащий JspWriter из bodyContent'а.

javax.servlet.jsp
Интерфейс HttpJspPage

public abstract interface HttpJspPage

extends JspPage

Интерфейс HttpJspPage описывает взаимодействие, которое Класс Реализации JSP-Страницы обязан выполнять при использовании протокола HTTP.

Поведение идентично JspPage, за исключением подписи метода _jspService, который теперь выражается в системе типов Java и включён в интерфейс явно.

См. также:

JspPage

Метод. Резюме.
void	_jspService (javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)           Метод _jspService() соответствует телу JSP-страницы.

 

Методы, унаследованные от интерфейса javax.servlet.jsp.JspPage

jspDestroy, jspInit

 

Методы, унаследованные от интерфейса javax.servlet.Servlet

destroy, getServletConfig, getServletInfo, init, service

 

Метод. Детали.

_jspService

public void _jspService(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws javax.servlet.ServletException,
                        java.io.IOException

Метод _jspService() соответствует телу/body JSP-страницы. Этот метод определяется автоматически JSP-контейнером и никогда не должен определяться автором JSP-страницы.

Если суперкласс специфицирован с использованием атрибута extends, этот суперкласс может избрать выполнение некоторых акций в своём методе service() до или после вызова метода _jspService().
См. использование атрибута extends в главе JSP_Engine/Машина спецификации JSP.

javax.servlet.jsp.tagext
Интерфейс IterationTag

Все Известные Субинтерейсы:

BodyTag

Все Известные Реализующие Классы:

TagSupport

public abstract interface IterationTag

extends Tag

Интерфейс IterationTag расширяет Tag, определяя один дополнительный метод, управляющий повторяющимися вычислениями тела.

Обработчик тэга, реализующий IterationTag, рассматривается как обработчик, реализующий Tag, с учётом методов doStartTag() и doEndTag(). IterationTag предоставляет новый метод: doAfterBody().

Метод doAfterBody() вызывается после каждого обсчёта тела для управления повторными вычислениями тела. Если doAfterBody() возвращает IterationTag.EVAL_BODY_AGAIN, то тело будет вычисляться ещё раз.
Если doAfterBody() возвращает Tag.SKIP_BODY, тело будет пропущено, и вместо этого будет вычислен doEndTag().

Свойства

Нет новых свойств, дополняющих свойства Tag'а.

Методы

Есть один новый метод: doAfterBody().

Жизненный цикл

Детали жизненного цикла показаны на диаграмме. Исключения, вызываемые в процессе вычисления doStartTag(), BODY и doAfterBody() прерывают выполнение и помещаются на верх стэка, если только обработчик тэга не реализует интерфейс TryCatchFinally; см. детали об этом интерфейсе.

Пустая и Непустая Акция

Если TagLibraryDescriptor-файл указывает, что акция всегда обязана иметь пустую акцию, через вхождение <body-content> - "empty", то метод doStartTag() обязан возвратить SKIP_BODY. Иначе, метод doStartTag() может возвратить SKIP_BODY или EVAL_BODY_INCLUDE.

Если возвращено SKIP_BODY, тело не вычисляется и вызывается doEndTag().

Если возвращено EVAL_BODY_INCLUDE, тело вычисляется и "передаётся" текущему out, затем вызывается doAfterBody() и, после 0 или более итераций, вызывается doEndTag().

Поле. Резюме.
static int	EVAL_BODY_AGAIN           Запрос на вычисление тела.

 

Поля, унаследованные из класса javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

 

Метод. Резюме.
int	doAfterBody ()           Производит (повторное) вычисление тела.

 

Методы, унаследованные из интерфейса javax.servlet.jsp.tagext.Tag

doEndTag, doStartTag, getParent, release, setPageContext, setParent

 

Поле. Детали.

EVAL_BODY_AGAIN

public static final int EVAL_BODY_AGAIN

Запрашивает вычисление некоторого тела. Возвращается из doAfterBody. Для обеспечения совместимости с JSP 1.1, значение тщательно выбирается, чтобы быть таким же, как и, ныне не рекомендуемое, BodyTag.EVAL_BODY_TAG,

doAfterBody

public int doAfterBody()
                throws JspException

Производит (повторное) вычисление тела. Этот метод вызывается объектом реализации JSP-страницы после каждого вычисления тела в объекте BodyEvaluation. Этот метод не вызывается. если нет вычисления тела.

Если doAfterBody возвращает EVAL_BODY_AGAIN, происходит новое вычисление тела (с последующим новым вызовом doAfterBody).
Если doAfterBody возвращает SKIP_BODY, больше вычисление тела не производится, значение out будет восстановлено методом popBody в pageContext и будет затем вызван doEndTag.

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

JSP-контейнер будет ресинхронизировать любые значения переменных, которые обозначены как таковые в TagExtraInfo, после вызова doAfterBody().

Возвращает:

нужны ли дополнительные обсчёты тела.

Вызывает:

JspException

javax.servlet.jsp
Класс JspEngineInfo

java.lang.Object
  |
  +--javax.servlet.jsp.JspEngineInfo

public abstract class JspEngineInfo

extends java.lang.Object

JspEngineInfo это абстрактный класс, предоставляющий информацию о текущей JSP-машине.

Конструктор. Резюме.

JspEngineInfo ()

 

Метод.Резюме.
abstract  java.lang.String	getSpecificationVersion ()           Возвращает номер версии спецификации JSP, которая поддерживается данной JSP-машиной.

 

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Конструктор. Детали.

JspEngineInfo

public JspEngineInfo()

getSpecificationVersion

public abstract java.lang.String getSpecificationVersion()

Возвращает номер версии спецификации JSP, которая поддерживается данной JSP-машиной.

Спецификация номера версии состоит из положительных десятичных целых чисел, разделённых точками ".", например, "2.0" или "1.2.3.4.5.6.7". Это позволяет использовать расширяемый номер для обозначения major, minor, micro и др. версий. Номер версии обязан начинаться с цифры.

Возвращает:

версию спецификации, null возвращается, если версия не известна.

javax.servlet.jsp
Класс JspException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--javax.servlet.jsp.JspException

Прямые Известные Подклассы:

JspTagException

public class JspException

extends java.lang.Exception

Общее исключение, известное JSP-машине; неотловленное JspExceptions приводит к вызову механизма errorpage.

См. также:

Сериализованная Форма

Конструктор. Резюме.

JspException ()           Конструирует JspException.

JspException (java.lang.String msg)           Конструирует новое JSP-исключение со специфицированным сообщением.

JspException (java.lang.String message, java.lang.Throwable rootCause)           Конструирует новое JSP-исключение, когда JSP нужно вызывать исключение, и включает сообщение об "основной причине" исключения, которая конфликтует с нормальным ходом процесса, включая сообщение описания.

JspException (java.lang.Throwable rootCause)           Конструирует новое JSP-исключение, когда JSP нужно вызывать исключение, и включает сообщение об "основной причине" исключения, которая конфликтует с нормальным ходом процесса.

 

Метод. Резюме.
java.lang.Throwable	getRootCause ()           Возвращает исключение, вызвавшее это JSP-исключение.

 

Методы, унаследованные от класса java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString

 

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Конструктор. Детали.

JspException

public JspException()

Конструирует JspException.

JspException

public JspException(java.lang.String msg)

Конструирует новое JSP-исключение со специфицированным сообщением. Сообщение может быть записано в log-файл сервера и/или выведено пользователю.

Параметры:

msg - String, специфицирующая текст сообщения исключения.

JspException

public JspException(java.lang.String message,
                    java.lang.Throwable rootCause)

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

Параметры:

message - String, содержащая текст сообщения исключения.

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

JspException

public JspException(java.lang.Throwable rootCause)

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

Этот метод вызывает метод getLocalizedMessage в исключении Throwable для получения локализованного сообщения исключения. При создании подкласса от JspException этот метод может быть переопределён для создания сообщения исключения, разработанного для конкретного места (язык, страна...).

Параметры:

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

getRootCause

public java.lang.Throwable getRootCause()

Возвращает исключение, вызвавшее данное JSP-исключение.

Возвращает:

Throwable, вызвавшее данное JSP-исключение.

javax.servlet.jsp
Класс JspFactory

java.lang.Object
  |
  +--javax.servlet.jsp.JspFactory

public abstract class JspFactory

extends java.lang.Object

JspFactory это абстрактный класс, определяющий несколько "фабричных"/factory методов, доступных JSP-странице на этапе прогона, для создания экземпляров различных интерфейсов и классов, используемых для поддержки реализации JSP.

Соответствующая требованиям реализация JSP-Машины будет в процессе своей инициализации инстанциировать зависящий от реализации подкласс этого класса и сделает его глобально доступным для использования классами реализации JSP посредством регистрации экземпляра, созданного данным классом с помощью static-метода setDefaultFactory().

Классы PageContext и JspEngineInfo являются единственными зависящими от реализации классами, которые могут создаваться только в фактории.

Объекты JspFactory не должны использоваться авторами JSP-страниц.

Конструктор. Резюме.

JspFactory ()

 

Метод. Резюме.
static JspFactory	getDefaultFactory ()
abstract  JspEngineInfo	getEngineInfo ()            вызывается для получения специфической для данной реализации информации о текущей JSP-машине.
abstract  PageContext	getPageContext (javax.servlet.Servlet servlet, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, java.lang.String errorPageURL, boolean needsSession, int buffer, boolean autoflush)            получает экземпляр зависящего от реализации абстрактного класса javax.servlet.jsp.PageContext для вызова Servlet и текущего обслуживания запроса и ответа.
abstract  void	releasePageContext (PageContext pc)            вызывается для освобождения ранее размещённого объекта PageContext.
static void	setDefaultFactory (JspFactory deflt)            установить факторию по умолчанию для данной реализации.

 

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Конструктор. Детали.

JspFactory

public JspFactory()

setDefaultFactory

public static void setDefaultFactory(JspFactory deflt)

установить факторию по умолчанию для данной реализации.
Только среда прогона программ JSP-Машина может вызывать этот метод.

Параметры:

default - реализация фактории по умолчанию.

getDefaultFactory

public static JspFactory getDefaultFactory()

Возвращает:

фактория по умолчанию для данной реализации.

getPageContext

public abstract PageContext getPageContext(javax.servlet.Servlet servlet,
                                           javax.servlet.ServletRequest request,
                                           javax.servlet.ServletResponse response,
                                           java.lang.String errorPageURL,
                                           boolean needsSession,
                                           int buffer,
                                           boolean autoflush)

получает экземпляр зависящего от реализации абстрактного класса javax.servlet.jsp.PageContext для вызова Servlet и текущего обслуживания запроса и ответа.

Этот метод обычно вызывается до процессинга метода _jspService() класса реализации JSP, чтобы получить объект PageContext для обрабатываемого запроса.

Вызов этого метода должен приводить к вызову метода PageContext.initialize().
Возвращаемый PageContext инициализируется соответствующим образом.

Все PageContext-объекты, полученные с помощью данного метода, должны уничтожаться через вызов releasePageContext().

Параметры:

servlet - запрашивающий сервлет

config - ServletConfig для запрашивающего Servlet'а

request - текущий запрос/request, обслуживаемый сервлетом

response - текущий ответ/response, обслуживаемый сервлетом

errorPageURL - URL страницы ошибок для запрашивающей JSP, или null

needsSession - true, если JSP участвует в сессии

buffer - размер буфера в байтах, PageContext.NO_BUFFER - если буфера нет, PageContext.DEFAULT_BUFFER - если буфер по умолчанию для данной реализации

autoflush - должен ли буфер автоматически очищаться в потоке вывода, или вызывать IOException?

Возвращает:

контекст страницы

См. также:

PageContext

releasePageContext

public abstract void releasePageContext(PageContext pc)

вызывается для уничтожения/освобождения ранее размещённого PageContext-объекта. результатом является вызов PageContext.release().
Этот метод должен вызываться до возвращения из метода _jspService() класса реализации JSP.

Параметры:

pc - PageContext, полученный ранее методом getPageContext()

getEngineInfo

public abstract JspEngineInfo getEngineInfo()

вызывается для получения специфической для данной реализации информации о текущей JSP-машине.

Возвращает:

JspEngineInfo-объект, описывающий текущую JSP-машину.

javax.servlet.jsp
Интерфейс JspPage

Все Известный Субинтерфейсы:

HttpJspPage

public abstract interface JspPage

extends javax.servlet.Servlet

Интерфейс JspPage описывает общее взаимодействие, которое класс Реализации JSP-Страницы обязан выполнять; страницы, использующие протокол HTTP, описаны интерфейсом HttpJspPage.

Методы Два плюс Один/Two plus One

Этот интерфейс определяет протокол с 3 методами; только два из них: jspInit() и jspDestroy() являются частью данного интерфейса, так как подпись/signature третьего метода: _jspService() зависит от специфики используемого протокола и не может быть выражена общим способом в Java.

Класс, реализующий этот интерфейс, отвечает за вызов вышеуказанных методов в подходящее время на базе вызовов соответствующих Servlet-базирующихся методов.

Методы jspInit() и jspDestroy() могут определяться автором JSP, но метод _jspService() определяется автоматически JSP-процессором на базе содержимого JSP-страницы.

_jspService()

Метод _jspService() соответствует телу/body JSP-страницы. Этот метод определяется автоматически JSP-контейнером и никогда не должен определяться автором JSP.

Если суперкласс специфицируется с использованием атрибута extends, этот суперкласс может избрать выполнение некоторых акций в методе service() до или после вызова метода _jspService().
См. использование атрибута extends в главе JSP_Машина спецификации JSP.

Специфика подписи/signature зависит от протокола, поддерживаемого JSP-страницей.

 public void _jspService(ServletRequestSubtype request,
                             ServletResponseSubtype response)
        throws ServletException, IOException;
 

Метод. Резюме.
void	jspDestroy ()           Метод jspDestroy() вызывается при уничтожении JSP-страницы.
void	jspInit ()          Метод jspInit() вызывается при инициализации JSP-страницы.

 

Методы, унаследованные от интерфейса javax.servlet.Servlet

destroy, getServletConfig, getServletInfo, init, service

 

Метод. Детали.

jspInit

public void jspInit()

Метод jspInit() вызывается при инициализации JSP-страницы. Реализация JSP (и класс, упомянутый атрибутом extends, если имеется) отвечает за то, что с этого момента вызовы метода getServletConfig() будут возвращать нужное значение. JSP-страница может переопределять этот метод через включение его определения в элемент declaration. JSP-страница должна переопределять метод init() из Servlet.

jspDestroy

public void jspDestroy()

Метод jspDestroy() вызывается при уничтожении JSP-страницы. JSP-страница может переопределять этот метод через включение его определения в элемент declaration. JSP-страница должна переопределять метод destroy() из Servlet.

javax.servlet.jsp
Класс JspTagException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--javax.servlet.jsp.JspException
                    |
                    +--javax.servlet.jsp.JspTagException

public class JspTagException

extends JspException

Исключение, используемое Обработчиком Тэга для указания на непреодолимую ошибку. Эта ошибка отлавливается на верхнем уровне JSP-страницы и выводит страницу об ошибках.

См. также:

Serialized Form

Конструктор. Резюме.

JspTagException ()           Нет сообщения.

JspTagException (java.lang.String msg)           Конструктор с сообщением..

 

Методы, унаследованные от класса javax.servlet.jsp.JspException

getRootCause

 

Методы, унаследованные от класса java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString

 

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Конструктор. Детали.

JspTagException

public JspTagException(java.lang.String msg)

Конструктор с сообщением..

JspTagException

public JspTagException()

Нет сообщения.

javax.servlet.jsp
Класс JspWriter

java.lang.Object
  |
  +--java.io.Writer
        |
        +--javax.servlet.jsp.JspWriter

Прямые Известные Подклассы:

BodyContent

public abstract class JspWriter

extends java.io.Writer

Акции и шаблонные данные на JSP-странице записываются с использованием JspWriter-объекта, на который ссылаются через неявную переменную out, инициализируемую автоматически, через использование методов в PageContext-объекте.

Этот абстрактный класс эмулирует некоторую функциональность классов java.io.BufferedWriter и java.io.PrintWriter, однако отличие в том, что он взывает java.io.IOException из методов print, в то время как PrintWriter этого не делает.

Буферизация

Начальный/initial JspWriter-объект ассоциируется с PrintWriter-объектом ServletResponse'а способом, зависящим от того, буферизуется страница или нет. Если страница буферизуется, вывод, записываемый в этот JspWriter-объект, будет записываться непосредственно через PrintWriter, который, если необходимо, будет создаваться путём вызова метода getWriter() в объекте response. Но если страница буферизуется, PrintWriter-объект не будет создаваться, пока буфер не очистится и операции типа setContentType() являются законными. Поскольку такая гибкость значительно упрощает программирование, буферизация в JSP-страницах выполняется по умолчанию.

Буферизация затрагивает вопрос: что делать, если буфер заполнен?
Есть два подхода к решению этой проблемы:

• Переполнение буфера не является фатальной ошибкой; если буфер заполнен, вывод просто очищается.
• Переполнение буфера является фатальной ошибкой; если буфер заполнен, вызывается исключение.

Оба подхода являются верными, и, соответственно, оба поддерживаются JSP-технологией. Поведение страницы контролируется атрибутом autoFlush, который по умолчанию - true. В общем, JSP-страницы, которым необходима гарантия корректности и полноты данных, высылаемых клиенту, могут установить атрибут autoFlush в false, что обычно делается в случае, если клиентом является само приложение. С другой стороны, JSP-страницы, отсылающие данные клиенту, могут даже после частичного конструирования установить атрибут autoFlush в true; что делается тогда, когда данные сразу выводятся через браузер. Каждое приложение действует в соответствии со своими потребностями.

Альтернативным было снятие ограничений на размер буфера; но это имело тот недостаток, что вычисления на этапе прогона могли поглотить неограниченное количество ресурсов ОС.

Неявная переменная "out" класса реализации JSP имеет этот тип. Если директива page избирает autoflush="true", тогда все операции I/O (ввода-вывода) этого класса автоматически очищают содержимое буфера, если условие overflow/переполнение могло бы возникнуть при выполнении текущей операции без очистки. Если autoflush="false", тогда все операции I/O (ввода-вывода) этого класса будут вызывать исключение IOException, если при выполнении текущей операции приводит к условию overflow/переполнения буфера.

См. также:

Writer, java.io.BufferedWriter, PrintWriter

Поле. Резюме.
protected  boolean	autoFlush
protected  int	bufferSize
static int	DEFAULT_BUFFER           константа, указывающая, что Writer буферизуется и использует размер буфера по умолчанию для данной реализации.
static int	NO_BUFFER           константа, указывающая, что Writer не буферизует вывод.
static int	UNBOUNDED_BUFFER           константа, указывающая, что Writer буферизуется и размер буфера не ограничен; это используется в BodyContent.

 

Поля, унаследованные от класса java.io.Writer

lock

 

Конструктор. Резюме.
protected	JspWriter (int bufferSize, boolean autoFlush)           protected-конструктор.

 

Метод. Резюме.
abstract  void	clear ()           Очищает содержимое буфера.
abstract  void	clearBuffer ()           Очищает текущее содержимое буфера.
abstract  void	close ()           Закрывает поток, предварительно очистив его. Этот метод не должен вызываться явно для начального/initial JspWriter'а, так как код, генерируемый JSP-контейнером, будет автоматически включать вызов close().
abstract  void	flush ()           Очищает поток.
int	getBufferSize ()           Этот метод возвращает размер буфера, используемого JspWriter'ом.
abstract  int	getRemaining ()           Этот метод возвращает количество неиспользуемых байтов буфера.
boolean	isAutoFlush ()           Этот метод указывает, очищается ли JspWriter автоматически.
abstract  void	newLine ()           Записывает символы новой строки.
abstract  void	print (boolean b)           Печатает булево значение.
abstract  void	print (char c)           Печатает символ.
abstract  void	print (char[] s)           Печатает массив символов.
abstract  void	print (double d)           Печатает число с плавающей точкой двойной точности.
abstract  void	print (float f)           Печатает число с плавающей точкой.
abstract  void	print (int i)           Печатает целое число.
abstract  void	print (long l)           Печатает длинное целое число.
abstract  void	print (java.lang.Object obj)           Печатает объект.
abstract  void	print (java.lang.String s)           Печатает строку.
abstract  void	println ()           Заканчивает текущую строку печатью символов новой строки.
abstract  void	println (boolean x)           Печатает булево значение и затем оканчивает строку.
abstract  void	println (char x)           Печатает символ и затем оканчивает строку.
abstract  void	println (char[] x)           Печатает массив символов и затем оканчивает строку.
abstract  void	println (double x)           Печатает число с плавающей точкой двойной точности и затем оканчивает строку.
abstract  void	println (float x)           Печатает число с плавающей точкой и затем оканчивает строку.
abstract  void	println (int x)           Печатает целое число и затем оканчивает строку.
abstract  void	println (long x)           Печатает длинное целое число и затем оканчивает строку.
abstract  void	println (java.lang.Object x)           Печатает Object и затем оканчивает строку.
abstract  void	println (java.lang.String x)           Печатает String и затем оканчивает строку.

 

Методы, унаследованные от класса java.io.Writer

write, write, write, write, write

 

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Поле. Детали.

NO_BUFFER

public static final int NO_BUFFER

константа, указывающая, что Writer не буферизует вывод.

DEFAULT_BUFFER

public static final int DEFAULT_BUFFER

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

UNBOUNDED_BUFFER

public static final int UNBOUNDED_BUFFER

константа, указывающая, что Writer буферизуется и размер буфера не ограничен; испоьзуется в  BodyContent.

bufferSize

protected int bufferSize

autoFlush

protected boolean autoFlush

JspWriter

protected JspWriter(int bufferSize,
                    boolean autoFlush)

protected-конструктор.

newLine

public abstract void newLine()
                      throws java.io.IOException

Записывает разделитель строк. Строковое значение разделителей строк определяется системным свойством line.separator, и это не обязательно может быть один символ новой строки ('\n').

Вызывает:

java.io.IOException - если возникает ошибка I/O (ввода-вывода).

print

public abstract void print(boolean b)
                    throws java.io.IOException

Печатает булево значение. Строка, производимая методом String.valueOf(boolean), транслируется в байты в соответствии с кодировкой символов по умолчанию на данной платформе, и эти байты записываются точно в манере метода Writer.write(int).

Параметры:

b - печатаемое boolean.

Вызывает:

java.io.IOException

print

public abstract void print(char c)
                    throws java.io.IOException

Печатает символ. Символ транслируется в один или более байтов в соответствии с кодировкой символов по умолчанию на данной платформе, и эти байты записываются точно в манере метода Writer.write(int).

Параметры:

c - печатаемый char.

Вызывает:

java.io.IOException

print

public abstract void print(int i)
                    throws java.io.IOException

Печатает целое число. Строка, производимая методом String.valueOf(int), транслируется в байты в соответствии с кодировкой символов по умолчанию на данной платформе, и эти байты записываются точно в манере метода Writer.write(int).

Параметры:

i - печатаемое int.

Вызывает:

java.io.IOException

См. также:

java.lang.Integer#toString(int)

print

public abstract void print(long l)
                    throws java.io.IOException

Печатает длинное целое. Строка, производимая методом by String.valueOf(long), транслируется в байты в соответствии с кодировкой символов по умолчанию на данной платформе, и эти байты записываются точно в манере метода Writer.write(int).

Параметры:

l - печатаемое long.

Вызывает:

java.io.IOException -  

См. также:

java.lang.Long#toString(long)

print

public abstract void print(float f)
                    throws java.io.IOException

Печатает число с плавающей точкой. Строка, производимая методом String.valueOf(float) , транслируется в байты в соответствии с кодировкой символов по умолчанию на данной платформе, и эти байты записываются точно в манере метода Writer.write(int).

Параметры:

f - печатаемое float.

Вызывает:

java.io.IOException

См. также:

java.lang.Float#toString(float)

print

public abstract void print(double d)
                    throws java.io.IOException

Печатает число с плавающей точкой двойной точности. Строка, производимая методом  String.valueOf(double) , транслируется в байты в соответствии с кодировкой символов по умолчанию на данной платформе, и эти байты записываются точно в манере метода Writer.write(int).

Параметры:

d - печатаемое double.

Вызывает:

java.io.IOException

См. также:

java.lang.Double#toString(double)

print

public abstract void print(char[] s)
                    throws java.io.IOException

Печатает массив символов. Символы конвертируются в байты в соответствии с кодировкой символов по умолчанию на данной платформе, и эти байты записываются точно в манере метода Writer.write(int).

параметры:

s - массив печатаемых chars.

Вызывает:

NullPointerException - если s равно null

java.io.IOException

print

public abstract void print(java.lang.String s)
                    throws java.io.IOException

Печатает строку. Если аргумент - null, тогда печатается строка "null". Иначе, символы строки  конвертируются в байты в соответствии с кодировкой символов по умолчанию на данной платформе, и эти байты записываются точно в манере метода Writer.write(int).

Параметры:

s - печатаемая String.

Вызывает:

java.io.IOException

print

public abstract void print(java.lang.Object obj)
                    throws java.io.IOException

Печатает объект. Строка, производимая методом String.valueOf(Object), транслируется в байты в соответствии с кодировкой символов по умолчанию на данной платформе, и эти байты записываются точно в манере метода Writer.write(int.

Параметры:

obj - печатаемый Object.

Вызывает:

java.io.IOException

См. также:

Object.toString()

println

public abstract void println()
                      throws java.io.IOException

Заканчивает текущую строку, печатая строку разделителей строк. Строка разделителей строк определяется системным свойством line.separator, и это не обязательно один символ новой строки ('\n').

Вызывает:

java.io.IOException

println

public abstract void println(boolean x)
                      throws java.io.IOException

Печатает булево значение и заканчивает строку. Этот метод ведёт себя так, будто он вызывает print(boolean) , а затем - println() .

Вызывает:

java.io.IOException

println

public abstract void println(char x)
                      throws java.io.IOException

Печатает символ и заканчивает строку. Этот метод ведёт себя так, будто он вызывает print(char) , а затем - println() .

Вызывает:

java.io.IOException

println

public abstract void println(int x)
                      throws java.io.IOException

Печатает целое число и заканчивает строку. Этот метод ведёт себя так, будто он вызывает print(int) , а затем - println() .

Вызывает:

java.io.IOException

println

public abstract void println(long x)
                      throws java.io.IOException

Печатает длинное целое число и заканчивает строку. Этот метод ведёт себя так, будто он вызывает print(long) , а затем - println() .

Вызывает:

java.io.IOException

println

public abstract void println(float x)
                      throws java.io.IOException

Печатает число с плавающей точкой и заканчивает строку. Этот метод ведёт себя так, будто он вызывает print(float) , а затем - println() .

Вызывает:

java.io.IOException

println

public abstract void println(double x)
                      throws java.io.IOException

Печатает число с плавающей точкой двойной точности и заканчивает строку. Этот метод ведёт себя так, будто он вызывает print(double) , а затем - println() .

Вызывает:

java.io.IOException

println

public abstract void println(char[] x)
                      throws java.io.IOException

Печатает массив символов и заканчивает строку. Этот метод ведёт себя так, будто он вызывает print( char[]) , а затем - println() .

Вызывает:

java.io.IOException

println

public abstract void println(java.lang.String x)
                      throws java.io.IOException

Печатает String и заканчивает строку. Этот метод ведёт себя так, будто он вызывает print(String) , а затем - println() .

Вызывает:

java.io.IOException

println

public abstract void println(java.lang.Object x)
                      throws java.io.IOException

Печатает Object и заканчивает строку. Этот метод ведёт себя так, будто он вызывает print(Object) , а затем - println() .

Вызывает:

java.io.IOException

clear

public abstract void clear()
                    throws java.io.IOException

Очищает содержимое буфера. Если буфер уже был очищен, тогда операция clear должна вызывать IOException для обозначения указания на то, что некоторые данные безвозвратно записаны в поток вывода клиенту.

Вызывает:

java.io.IOException - если возникает ошибка I/O.

clearBuffer

public abstract void clearBuffer()
                          throws java.io.IOException

Очищает текущее содержимое буфера. В отличие от clear(), этот метод не вызывает исключение IOException, если буфер уже очищен. Он лишь очищает текущее содержимое буфера и возвращает управление.

Вызывает:

java.io.IOException - если возникает ошибка I/O.

flush

public abstract void flush()
                    throws java.io.IOException

Очищает (промывает/Flush) поток. Если поток сохранил в буфере любые символы из разных методов write(), немедленно записывает их по назначению. Затем, если назначением является другой символ или поток байтов, очищает поток. Таким образом, один вызов flush() будет очищать все буферы в цепи Writer'ов и OutputStream'ов.

Этот метод может быть вызван неявно, если размер буфера превышен.

После того как поток был закрыт, последующие вызовы методов write() или flush() приводят к вызову исключения IOException.

Вызывает:

java.io.IOException - если возникает ошибка I/O.

Переопределяет:

flush в классе java.io.Writer

close

public abstract void close()
                    throws java.io.IOException

Закрывает поток, предварительно очистив его.

Этот метод не должен вызываться явно для начального/initial JspWriter'а, так как код, генерируемый JSP-контейнером, будет автоматически включать вызов close().

Закрытие уже закрытого потока, в отличие от flush(), не даст никакого эффекта.

Вызывает:

java.io.IOException - если возникает ошибка I/O.

Переопределяет:

close в классе java.io.Writer

getBufferSize

public int getBufferSize()

Этот метод возвращает размер буфера, используемого JspWriter'ом.

Возвращает:

размер буфера в байтах или 0, если буферизации нет.

getRemaining

public abstract int getRemaining()

Этот метод возвращает количество неиспользуемых байтов в буфере.

Возвращает:

количество неиспользуемых байтов в буфере.

isAutoFlush

public boolean isAutoFlush()

Этот метод указывает, очищается ли JspWriter автоматически (autoFlush).

Возвращает:

очищается ли JspWriter автоматически, или вызывает исключение IOExceptions при выполнении условий переполнения буфера.

Пакет javax.servlet.jsp

См.:
           Описание

Интерфейс. Резюме.
HttpJspPage	Интерфейс HttpJspPage описывает взаимодействие, которое Класс Реализации JSP-Страницы обязан выполнять при использовании протокола HTTP.
JspPage	Интерфейс JspPage описывает типовое взаимодействие которое Класс Реализации JSP-Страницы обязан выполнять; страницы, использующие протокол HTTP, описываются интерфейсом HttpJspPage.

 

Класс. Резюме.
JspEngineInfo	JspEngineInfo это абстрактный класс, предоставляющий информацию о текущей JSP-машине.
JspFactory	JspFactory это абстрактный класс, определяющий несколько методов фактории, доступных JSP-странице на этапе прогона, для целей создания экземпляров различных интерфейсов и классов, используемых для поддержки реализации JSP.
JspWriter	Акции и шаблонные данные в JSP-странице, написанные с использованием JspWriter-объекта, на который ссылаются через неявную переменную out, которая инициализируется автоматически через использование методов в PageContext-объекте.
PageContext	PageContext-экземпляр, предоставляющий доступ ко всем пространствам имён, ассоциированным с JSP-страницей, к различным атрибутам страницы, а также слой поверх деталей реализации.

 

Исключение. Резюме.
JspException	Общее исключение, известное JSP-машине; неотловленное JspExceptions будет приводить к вызову механизмов errorpage.
JspTagException	Исключение, используемое Обработчиком Тэга для указания на непоправимую ошибку.

 

Иерархии Пакетов:

Все Пакеты

Иерархия Классов

• class java.lang.Object
  • class javax.servlet.jsp. JspEngineInfo
  • class javax.servlet.jsp. JspFactory
  • class javax.servlet.jsp. PageContext
  • class java.lang.Throwable (implements java.io.Serializable)
    • class java.lang.Exception
      • class javax.servlet.jsp. JspException
        • class javax.servlet.jsp. JspTagException
  • class java.io.Writer
    • class javax.servlet.jsp. JspWriter

Иерархия Интерфейсов

• interface javax.servlet.Servlet
  • interface javax.servlet.jsp. JspPage
    • interface javax.servlet.jsp. HttpJspPage

javax.servlet.jsp.tagext
Интерфейс Tag

Все Известные Субинтерфейсы:

BodyTag, IterationTag

public abstract interface Tag

Интерфейс простого обработчика тэга, который не манипулирует своим телом. Интерфейс Tag определяет базовый протокол между обработчиком Tag'а и классом реализации JSP-страницы. Определяет жизненный цикл и методы, вызываемые в начальном.

Свойства

Интерфейс Tag специфицирует setter- и getter-методы для основных свойств pageContext и parent.

Объект реализации JSP-страницы вызывает setPageContext и setParent, в указанной последовательности, до вызова doStartTag() или doEndTag().

Методы

Выполняются два главных действия: doStartTag и doEndTag. После того как соответствующие свойства инициализированы, методы doStartTag и doEndTag могут быть вызваны в обработчике тэга. Принимается, что между этими вызовами обработчик тэга поддерживает статус, который обязан быть сохранён.
После вызова doEndTag обработчик тэга доступен для последующих вызовов (и предполагается, что он сохраняет свои свойства).

Жизненный цикл

Детали жизненного цикла представлены на диаграмме, со следующими комментариями:

• [1] Этот перенос предназначен для освобождения длительно хранящихся данных. Нет никаких гарантий сохранения каких-либо свойств.
• [2] Этот перенос происходит, если, и только если, тэг заканчивается нормально, без вызова исключения.
• [3] Заметьте, что, поскольку нет никаких гарантий сохранения статуса свойств, обработчик тэга, имевший установленными некоторые необязательные/optional свойства, может быть использован повторно только в том случае, если эти свойства устанавливаются в новые (известные) значения. Это означает, что такие обработчики тэгов могут использоваться повторно только с тем же "AttSet" (набором атрибутов, которые уже установлены).
• Просмотрите интерфейс TryCatchFinally на предмет выяснения некоторых деталей относительно обработки исключений и обслуживания ресурсов.

После того как выполнены все вызовы обработчика тэга, в нём вызывается метод release.
После того как метод release вызван, принимается, что все свойства, включая parent и pageContext, восстановлены в неспецифицированные значения. Компилятор страницы гарантирует, что release() будет вызван в обработчике Tag'а до освобождения обработчика в GC.

Пустая и Непустая Акция

Если TagLibraryDescriptor-файл указывает, что акция должна всегда иметь пустую акцию, посредством вхождения <body-content> - "empty", тогда метод doStartTag() обязан возвращать SKIP_BODY. Иначе, метод doStartTag() может возвратить SKIP_BODY или EVAL_BODY_INCLUDE.

Если возвращено SKIP_BODY, тело, если имеется, не обсчитывается.

Если возвращено EVAL_BODY_INCLUDE, тело обсчитывается и "передаётся" текущему out.

Поле. Резюме.
static int	EVAL_BODY_INCLUDE           Вычисляет тело в существующем потоке out.
static int	EVAL_PAGE           Продолжить обсчёт страницы.
static int	SKIP_BODY           Пропустить вычисление тела.
static int	SKIP_PAGE           Пропустить остаток страницы.

 

Метод. Резюме.
int	doEndTag ()           Обработать конечный тэг данного экземпляра.
int	doStartTag ()           Обработать начальный тэг данного экземпляра.
Tag	getParent ()           Получить родителя (ближайший содержащий обработчик тэга) данного обработчика тэга.
void	release ()           Вызывается в обработчике Tag'а для освобождения состояния.
void	setPageContext (PageContext pc)           Устанавливает текущий контекст страницы.
void	setParent (Tag t)           Устанавливает родителя (ближайший содержащий обработчик тэга) данного обработчика тэга.

 

Поле. Детали.

SKIP_BODY

public static final int SKIP_BODY

Пропустить вычисление тела. Верное return-значение для doStartTag и doAfterBody.

EVAL_BODY_INCLUDE

public static final int EVAL_BODY_INCLUDE

Вычислить тело в существующем потоке out. Верное return-значение для doStartTag.

SKIP_PAGE

public static final int SKIP_PAGE

Пропустить остаток страницы. Верное return-значение для doEndTag.

EVAL_PAGE

public static final int EVAL_PAGE

Продолжить вычисление страницы. Верное return-значение для doEndTag().

setPageContext

public void setPageContext(PageContext pc)

Устанавливает текущий контекст страницы. Этот метод вызывается объектом реализации JSP-страницы до вызова doStartTag().

Это значение *не* восстанавливается/reset методом doEndTag() и обязано быть восстановлено явно реализацией страницы, если изменяется между вызовами doStartTag().

Параметры:

pc - контекст страницы для данного обработчика тэга.

setParent

public void setParent(Tag t)

Устанавливает родителя (ближайший содержащий обработчик тэга) данного обработчика тэга.
Вызывается объектом реализации JSP-страницы до вызова doStartTag().

Это значение *не* восстанавливается/reset методом doEndTag() и обязано быть восстановлено явно реализацией страницы.

Параметры:

t - родительский тэг/tag или null.

getParent

public Tag getParent()

Получает родителя (ближайший содержащий обработчик тэга) данного обработчика тэга.

Метод getParent() может использоваться для навигации по структуре вложенного обработчика тэга на этапе прогона для кооперации нескольких акций; например, метод findAncestorWithClass() в TagSupport предоставляет удобный способ выполнения этого.

Текущая версия спецификации предоставляет только один формальный способ обозначения рассматриваемого типа обработчика тэга: класс реализации обработчика тэга, описанный в субэлементе tag-class элемента tag. Он расширяется в неформальной манере, давая автору библиотеки тэгов возможность указывать в субэлементе description рассматриваемый тип. Тип должен быть подтипом класса реализации обработчика тэга или void. Это дополнительное ограничение может быть обработано специализированным контейнером, который знает о об этой конкретной библиотеке тэгов, как в случае со стандартной библиотекой тэгов JSP.

doStartTag

public int doStartTag()
               throws JspException

Обрабатывает начальный тэг данного экземпляра. Этот метод вызывается объектом реализации JSP-страницы.

Метод doStartTag принимает, что свойства pageContext и parent уже установлены. Он также принимает, что любые свойства, экспонированные как атрибуты, также установлены. Если этот метод вызывается, это означает, что тело ещё не обсчитывалось.

Этот метод возвращает Tag.EVAL_BODY_INCLUDE или BodyTag.EVAL_BODY_BUFFERED для указания на то, что тело акции должно быть обсчитано, или SKIP_BODY - для обозначения обратного.

Если Tag возвращает EVAL_BODY_INCLUDE, результат вычисления тела (если оно имеется) включается в текущий "out" JspWriter, как происходит при вызове doEndTag().

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

JSP-контейнер будет ресинхронизировать любые значения переменных, обозначенных как таковые в TagExtraInfo, после вызова doStartTag().

Вызывает:

JspException

См. также:

BodyTag

doEndTag

public int doEndTag()
             throws JspException

Обработать конечный тэг данного экземпляра. Этот метод вызывается объектом реализации JSP-страницы во всех обработчиках Tag'а.

Этот метод будет вызываться после возвращения из doStartTag. Тело акции может или может не быть вычисленным, в зависимости от return-занчения метода doStartTag.

Если этот метод возвращает EVAL_PAGE, остаток страницы продолжает обсчитываться.
Если этот метод возвращает SKIP_PAGE, остаток страницы не обсчитывается и запрос выполняется.
Если этот запрос был направлен или включён из другой страницы (или Servlet), выполняется обсчёт только текущей страницы.

JSP-контейнер будет ресинхронизировать любые значения переменных, обозначенных как таковые в TagExtraInfo, после вызова doEndTag().

Вызывает:

JspException

release

public void release()

Вызывается обработчиком Tag'а для освобождения статуса. Компилятор страницы гарантирует, что объекты реализации JSP-страницы будут вызывать этот метод во всех обработчиках тэгов, но могут быть неоднократные вызовы doStartTag и doEndTag между ними.

Пакет javax.servlet.jsp.tagext

См.:
           Описание

Интерфейс. Резюме.
BodyTag	Интерфейс BodyTag расширяет IterationTag путём определения дополнительных методов, позволяющих обработчику тэга манипулировать содержимым, вычисляя его тело.
IterationTag	Интерфейс IterationTag расширяет Tag путём определения дополнительного метода, управляющего повторными вычислениями его тела.
Tag	Интерфейс простого обработчика тэга, который не манипулирует его телом.
TryCatchFinally	Вспомогательный интерфейс для Tag, IterationTag или обработчика тэга BodyTag'а, которым нужны дополнительные возможности для обслуживания ресурсов.

 

Класс. Резюме.
BodyContent	Инкапсуляция вычисления/обсчёта тела акции, делающая её доступной обработчику тэга.
BodyTagSupport	Базовый класс для определения обработчиков тэгов, реализующих BodyTag.
PageData	Информация времени трансляции о JSP-странице.
TagAttributeInfo	Информация об атрибутах Tag'а, доступная на этапе трансляции.
TagData	Информация (только на этапе трансляции) пары attribute/value для экземпляра тэга.
TagExtraInfo	Необязательный/Optional класс, предоставляемый автором библиотеки тэгов, для описания информации времени трансляции, не описанной в TLD.
TagInfo	Tag-информация для тэга в Tag Library; этот класс инстанциируется из Tag Library Descriptor-файла (TLD) и доступен только на этапе трансляции.
TagLibraryInfo	Информация времени трансляции, ассоциированная с директивой taglib, и её TLD-файл.
TagLibraryValidator	Класс проверщика времени трансляции для JSP-страницы.
TagSupport	Базовый класс для определения новых обработчиков тэгов, реализующих Tag.
TagVariableInfo	Информация переменной для тэга в Библиотеке Тэгов; этот класс инстанциируется из Tag Library Descriptor-файла (TLD) и доступен только на этапе трансляции.
ValidationMessage	Проверочное сообщение из TagLibraryValidator'а.
VariableInfo	Информация переменной скриптинга, созданной/модифицированной тэгом (на этапе прогона).

 

Описание Пакета javax.servlet.jsp.tagext

Классы и интерфейсы для определения Библиотек Тэгов JavaServer Pages.

Спецификация JavaServer Pages^(tm) (JSP) 1.2 предоставляет переносимый механизм описания библиотек тэгов.

Библиотека тэгов JSP содержит:

• Tag Library Descriptor/Дескриптор Библиотеки Тэгов;
• Несколько классов обработчика тэга, определяющих поведение на этапе запроса;
• Дополнительные классы и ресурсы, используемые на этапе прогона;
• Возможно, некоторые дополнительные классы для ввода дополнительной информации трансляции.

Спецификация JSP 1.2 и реализация, на которую имеются ссылки, содержат простые и довольно сложные примеры акций, определённых с использованием этого механизма. Они находятся на сайте JSP по адресу: http://java.sun.com/products/jsp . Некоторым читателям, возможно, понадобится консультироваться там для получения представления о том, как эти механизмы работают совместно.

Иерархии Пакетов:

Все Пакеты

Иерархия Классов

• class java.lang.Object
  • class javax.servlet.jsp.tagext. PageData
  • class javax.servlet.jsp.tagext. TagAttributeInfo
  • class javax.servlet.jsp.tagext. TagData (implements java.lang.Cloneable)
  • class javax.servlet.jsp.tagext. TagExtraInfo
  • class javax.servlet.jsp.tagext. TagInfo
  • class javax.servlet.jsp.tagext. TagLibraryInfo
  • class javax.servlet.jsp.tagext. TagLibraryValidator
  • class javax.servlet.jsp.tagext. TagSupport (implements javax.servlet.jsp.tagext.IterationTag, java.io.Serializable)
    • class javax.servlet.jsp.tagext. BodyTagSupport (implements javax.servlet.jsp.tagext.BodyTag)
  • class javax.servlet.jsp.tagext. TagVariableInfo
  • class javax.servlet.jsp.tagext. ValidationMessage
  • class javax.servlet.jsp.tagext. VariableInfo
  • class java.io.Writer
    • class javax.servlet.jsp. JspWriter
      • class javax.servlet.jsp.tagext. BodyContent

Иерархия Интерфесов

• interface javax.servlet.jsp.tagext. Tag
  • interface javax.servlet.jsp.tagext. IterationTag
    • interface javax.servlet.jsp.tagext. BodyTag
• interface javax.servlet.jsp.tagext. TryCatchFinally

javax.servlet.jsp
Класс PageContext

java.lang.Object
  |
  +--javax.servlet.jsp.PageContext

public abstract class PageContext

extends java.lang.Object

Экземпляр класса PageContext предоставляет доступ ко всем пространствам имён, ассоциированным с JSP-страницей, к различным атрибутам страницы, а также слой поверх деталей реализации.
Неявные объекты добавляются к pageContext автоматически.

Класс PageContext это абстрактный класс, разработанный с возможностью последующего расширения для предоставления реализаций, в зависимости от свойств самих же реализаций, в среде соответствующих JSP-машин. Экземпляр PageContext получается классом реализации JSP через вызов метода JspFactory.getPageContext(), и освобождается через вызов метода JspFactory.releasePageContext().

Примеры использования PageContext, JspFactory и других классов в объекте Реализации JSP-Страницы можно найти повсюду.

PageContext имеет особенности, упрощающие работу авторов страниц/компонентов и реализаторов страниц, в том числе:

• единый API для обслуживания пространств имён различных областей видимости;
• несколько удобных API для доступа к различным public-объектам;
• механизм получения JspWriter'а для вывода;
• механизм обслуживания использования сессии страницей;
• механизм экспонирования ("показа") атрибутов директивы page среде скриптинга;
• механизмы направления или включения текущего запроса в другие компоненты приложения;
• механизм обработки процессов исключений errorpage;

Методы, Предназначенные для Кода, Генерируемого Контейнером

Некоторые методы предназначены для использования кодом , генерируемым контейнером, а не кодом, написанным авторами JSP-страниц или библиотек тэгов JSP.

Методами, поддерживающими жизненный цикл, являются initialize() и release().

Методы делающие возможным обслуживание вложенных потоков JspWriter'а для реализации Расширений Тэгов: pushBody() и popBody()

Методы, Предназначенные для Авторов JSP

Некоторые методы предоставляют универсальный доступ к различным объектам, представляющим области видимости. Реализация обязана использовать фундаментальные механизмы Servlet, соответствующие данной области видимости, так что информация может быть передана вперёд и назад между Servlet'ами и JSP-страницами. Методы: setAttribute(), getAttribute(), findAttribute(), removeAttribute(), getAttributesScope() и getAttributeNamesInScope() .

Следующие методы предоставляют удобный доступ к неявным объектам:

getOut(), getException(), getPage() getRequest(), getResponse(), getSession(), getServletConfig() и getServletContext().

Следующие методы предоставляют поддержку для направления, включения и обработки ошибок: forward(), include() и handlePageException().

---

Поле. Резюме.
static java.lang.String	APPLICATION           Имя, используемое для хранения ServletContext в таблице имён PageContext.
static int	APPLICATION_SCOPE           Область видимости - приложение: именованные ссылки работают в ServletContext'е, пока он не будет вызван.
static java.lang.String	CONFIG           Имя, используемое для хранения ServletConfig в таблице имён PageContext.
static java.lang.String	EXCEPTION           Имя, используемое для хранения неотловленного исключения в списке атрибутов ServletRequest'а и в таблице имён PageContext.
static java.lang.String	OUT           Имя, используемое для хранения текущего JspWriter'а в таблице имён PageContext.
static java.lang.String	PAGE           Имя, используемое для хранения Servlet в таблицах имён этого PageContext.
static int	PAGE_SCOPE           Область видимости - страница: (это значение по умолчанию) именованные ссылки работают в этом PageContext'е до возвращения из текущего вызова метода Servlet.service().
static java.lang.String	PAGECONTEXT           Имя, используемое для хранения этого PageContext'а в его собственной таблице имён.
static java.lang.String	REQUEST           Имя, используемое для хранения  ServletRequest'а в таблице имён PageContext.
static int	REQUEST_SCOPE           Область видимости - запрос: именованные ссылки работают из ServletRequest'а, ассоциированного с Servlet'ом, пока выполнение текущего запроса не будет завершено.
static java.lang.String	RESPONSE           Имя, используемое для хранения  ServletResponse в таблице имён PageContext'а.
static java.lang.String	SESSION           Имя, используемое для хранения  HttpSession в таблице имён PageContext'а.
static int	SESSION_SCOPE           Область видимости - сессия (верно, только если данная страница участвует в сессии): именованные ссылки работают из HttpSession (если имеется), ассоциированного с Servlet'ом, пока HttpSession не будет закрыта.

 

Конструктор. Резюме.

PageContext ()

 

Метод. Резюме.
abstract  java.lang.Object	findAttribute (java.lang.String name)           Ищет именованный атрибут в области(-ях) видимости page, request, session (если запущена) и application, в указанном порядке, и возвращает ассоциированное значение или null.
abstract  void	forward (java.lang.String relativeUrlPath)            Этот метод используется для перенаправления текущего ServletRequest'а и ServletResponse'а другому активному компоненту приложения.
abstract  java.lang.Object	getAttribute (java.lang.String name)           Возвращает объект, ассоциированный с именем в области видимости page, или null, если объект не найден.
abstract  java.lang.Object	getAttribute (java.lang.String name, int scope)           Возвращает объект, ассоциированный с именем в специфицированной области видимости, или null, если объект не найден.
abstract  java.util.Enumeration	getAttributeNamesInScope (int scope)           Перечисляет все атрибуты в данной области видимости.
abstract  int	getAttributesScope (java.lang.String name)           Получит область видимости, в которой определён данный атрибут.
abstract  java.lang.Exception	getException ()           Текущее значение объекта исключения (Exception).
abstract  JspWriter	getOut ()           Текущее значение объекта out (JspWriter).
abstract  java.lang.Object	getPage ()           Текущее значение объекта page (Servlet).
abstract  javax.servlet.ServletRequest	getRequest ()           Текущее значение объекта request (ServletRequest).
abstract  javax.servlet.ServletResponse	getResponse ()           Текущее значение объекта response (ServletResponse).
abstract  javax.servlet.ServletConfig	getServletConfig ()           ServletConfig-экземпляр.
abstract  javax.servlet.ServletContext	getServletContext ()           ServletContext-экземпляр.
abstract  javax.servlet.http.HttpSession	getSession ()           Текущее значение объекта session (HttpSession).
abstract  void	handlePageException (java.lang.Exception e)            Этот метод предназначен для обработки необработанного исключения уровня "page" путём перенаправления исключения специфицированной для данной JSP-страницы странице ошибок, либо, если ничего не было специфицировано, выполняя некоторое зависящее от реализации действие.
abstract  void	handlePageException (java.lang.Throwable t)            Этот метод идентичен handlePageException(Exception), за исключением того, что он принимает Throwable.
abstract  void	include (java.lang.String relativeUrlPath)            Вызывает обработку специфицированных ресурсов как части текущих ServletRequest и ServletResponse, обрабатываемых вызывающим Thread/потоком.
abstract  void	initialize (javax.servlet.Servlet servlet, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, java.lang.String errorPageURL, boolean needsSession, int bufferSize, boolean autoFlush)            Метод initialize вызывается для инициализации неинициализированного PageContext'а так, что он (РС) может использоваться классом Реализации JSP для обслуживания входящих запросов и ответов внутри метода _jspService().
JspWriter	popBody ()           Возвращает "out" предыдущего JspWriter'а, сохраняемый парным pushBody() и обновляет значение атрибута "out" в пространстве имён атрибутов из области видимости page PageConxtext'а.
BodyContent	pushBody ()           Возвращает BodyContent-объект, сохраняет текущий "out" JspWriter и обновляет значение атрибута "out" в пространстве имён атрибутов из области видимости page PageConxtext'а.
abstract  void	release ()            Этот метод будет "восстанавливать/reset" начальное состояние PageContext'а, освобождая все ссылки и подготавливая PageContext для возможного использования в последующих вызовах initialize().
abstract  void	removeAttribute (java.lang.String name)           Удаляет ссылку на объект, ассоциированный с данным именем, просматривая во всех областях видимости в (установленном) порядке просмотра.
abstract  void	removeAttribute (java.lang.String name, int scope)           Удаляет ссылку на объект, ассоциированный со специфицированным именем в данной области видимости.
abstract  void	setAttribute (java.lang.String name, java.lang.Object attribute)           Регистрирует имя/name и объект/object, специфицированные семантикой области видимости scope.
abstract  void	setAttribute (java.lang.String name, java.lang.Object o, int scope)           Регистрирует имя/name и объект/object, специфицированные семантикой соответствующей области видимости.

 

Методы, унаследованные из класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Поле. Детали.

PAGE_SCOPE

public static final int PAGE_SCOPE

Область видимости - страница: (по умолчанию) именованная ссылка работает в данном PageContext до возвращения из текущего вызова Servlet.service().

---

REQUEST_SCOPE

public static final int REQUEST_SCOPE

Область видимости - запрос: именованная ссылка работает в данном ServletRequest, ассоциированном с Servlet, до завершения выполнения текущего запроса.

---

SESSION_SCOPE

public static final int SESSION_SCOPE

Область видимости - сессия (верно, только если данная страница участвует в сессии): именованная ссылка работает в данной HttpSession (если запущена), ассоциированной с Servlet'ом, до закрытия HttpSession.

---

APPLICATION_SCOPE

public static final int APPLICATION_SCOPE

Область видимости - приложение: именованная ссылка работает в данном ServletContext, пока он не будет затребован обратно.

---

PAGE

public static final java.lang.String PAGE

Имя, используемое для хранения Servlet'а в таблицах имён данного PageContext'а.

---

PAGECONTEXT

public static final java.lang.String PAGECONTEXT

Имя, используемое для хранения данного PageContext'а в его собственной таблице имён.

---

REQUEST

public static final java.lang.String REQUEST

Имя, используемое для хранения ServletRequest'а в таблице имён PageContext'а.

---

RESPONSE

public static final java.lang.String RESPONSE

Имя, используемое для хранения ServletResponse в таблице имён PageContext'а.

---

CONFIG

public static final java.lang.String CONFIG

Имя, используемое для хранения ServletConfig'а в таблице имён PageContext'а.

---

SESSION

public static final java.lang.String SESSION

Имя, используемое для хранения HttpSession в таблице имён PageContext'а.

---

OUT

public static final java.lang.String OUT

Имя, используемое для хранения текущего JspWriter'а в таблице имён PageContext'а.

---

APPLICATION

public static final java.lang.String APPLICATION

Имя, используемое для хранения ServletContext'а в таблице имён PageContext'а.

---

EXCEPTION

public static final java.lang.String EXCEPTION

Имя, используемое для хранения неотловленного исключения в списке атрибутов ServletRequest'а и в таблице имён PageContext'а.

Конструктор. Детали.

PageContext

public PageContext()

Метод. Детали.

initialize

public abstract void initialize(javax.servlet.Servlet servlet,
                                javax.servlet.ServletRequest request,
                                javax.servlet.ServletResponse response,
                                java.lang.String errorPageURL,
                                boolean needsSession,
                                int bufferSize,
                                boolean autoFlush)
                         throws java.io.IOException,
                                java.lang.IllegalStateException,
                                java.lang.IllegalArgumentException

Метод initialize вызывается для инициализации неинициализированного PageContext'а так, что он (РС) может быть использован классом Реализации JSP для обслуживания входящего запроса и ответа внутри метода _jspService().

Этот метод обычно вызывается из JspFactory.getPageContext(), чтобы инициализировать статус.

Этот метод нужен для создания начального JspWriter'а и ассоциирования имени "out'а" в области видимости page с этим вновь созданным объектом.

Этот метод не должен использоваться авторами страниц или библиотек тэгов.

Параметры:

servlet - Servlet, ассоциированный с данным PageContext'ом

request - текущий запрос в данном Servlet'е

response - текущий ответ для данного Servlet'а

errorPageURL - значение атрибута errorpage из директивы page или null

needsSession - значение атрибута session из директивы page

bufferSize - значение атрибута buffer из директивы page

autoFlush - значение атрибута autoflush из директивы page

Вызывает:

java.io.IOException - во время создания JspWriter

java.lang.IllegalStateException - если out некорректно инициализирован

---

release

public abstract void release()

Этот метод будет "восстанавливать/reset" начальное состояние PageContext'а, освобождая все ссылки и подготавливая PageContext для возможного использования в последующих вызовах initialize(). Этот метод обычно вызывается из JspFactory.releasePageContext().

Подклассы должны включать этот метод (быть оболочкой).

Этот метод не должен использоваться авторами страниц или библиотек тэгов.

---

setAttribute

public abstract void setAttribute(java.lang.String name,
                                  java.lang.Object attribute)

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

Параметры:

name - имя атрибута для установки

attribute - объект для ассоциирования с именем

Вызывает:

NullPointerException - если name или object - null

---

setAttribute

public abstract void setAttribute(java.lang.String name,
                                  java.lang.Object o,
                                  int scope)

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

Параметры:

name - имя атрибута для установки

o - объект для ассоциирования с именем

scope - область видимости, с которой ассоциируется name/object

Вызывает:

NullPointerException - если name или object - null

java.lang.IllegalArgumentException - если область видимости неверна

---

getAttribute

public abstract java.lang.Object getAttribute(java.lang.String name)

Возвращает объект, ассоциированный с именем в области видимости page, или null, если не найден.

Параметры:

name - имя получаемого атрибута

Вызывает:

NullPointerException - если name - null

java.lang.IllegalArgumentException - если область видимости неверна

---

getAttribute

public abstract java.lang.Object getAttribute(java.lang.String name,
                                              int scope)

Возвращает объект, ассоциированный с именем в специфицированной области видимости, или null, если не найден.

Параметры:

name - имя атрибута для установки

scope - область видимости, с которой ассоциируется name/object

Вызывает:

NullPointerException - если name - null

java.lang.IllegalArgumentException - если область видимости неверна

---

findAttribute

public abstract java.lang.Object findAttribute(java.lang.String name)

Ищет именованный атрибут в областях видимости page, request, session (если запущена) и application, в указанном порядке, и возвращает ассоциированное значение или null.

Возвращает:

ассоциированное значение или null

---

removeAttribute

public abstract void removeAttribute(java.lang.String name)

Удаляет ссылку на объект, ассоциированный с данным именем, просматривая все области видимости в установленном порядке просмотра.

Параметры:

name - имя удаляемого объекта.

---

removeAttribute

public abstract void removeAttribute(java.lang.String name,
                                     int scope)

Удаляет ссылку на объект, ассоциированный с данным именем, в данной области видимости.

Параметры:

name - имя удаляемого объекта.

scope - область видимости для просмотра.

---

getAttributesScope

public abstract int getAttributesScope(java.lang.String name)

Получает область видимости, где определён данный атрибут.

Возвращает:

область видимости объекта, ассоциированного со специфицированным именем, или 0.

---

getAttributeNamesInScope

public abstract java.util.Enumeration getAttributeNamesInScope(int scope)

Перечисляет все атрибуты в данной области видимости.

Возвращает:

перечисление имён (java.lang.String) всех атрибуты в специфицированной области видимости.

---

getOut

public abstract JspWriter getOut()

Текущее значение объекта out (JspWriter).

Возвращает:

текущий поток JspWriter'а, используемый для ответа клиенту.

---

getSession

public abstract javax.servlet.http.HttpSession getSession()

Текущее значение объекта session (HttpSession).

Возвращает:

HttpSession для данного PageContext'а или null.

---

getPage

public abstract java.lang.Object getPage()

Текущее значение объекта page (Servlet).

Возвращает:

экземпляр класса реализации Page (Servlet), ассоциированный с данным  pageContext'ом.

---

getRequest

public abstract javax.servlet.ServletRequest getRequest()

Текущее значение объекта request (ServletRequest).

Возвращает:

ServletRequest для данного PageContext'а.

---

getResponse

public abstract javax.servlet.ServletResponse getResponse()

Текущее значение объекта response (ServletResponse).

Возвращает:

ServletResponse для данного PageContext'а.

---

getException

public abstract java.lang.Exception getException()

Текущее значение объекта exception (Exception).

Возвращает:

любое исключение, передаваемое как errorpage.

---

getServletConfig

public abstract javax.servlet.ServletConfig getServletConfig()

Экземпляр ServletConfig'а.

Возвращает:

ServletConfig для данного PageContext'а.

---

getServletContext

public abstract javax.servlet.ServletContext getServletContext()

Экземпляр ServletContext'а.

Возвращает:

ServletContext для данного PageContext'а.

---

forward

public abstract void forward(java.lang.String relativeUrlPath)
                      throws javax.servlet.ServletException,
                             java.io.IOException

Этот метод используется для перенаправления текущих ServletRequest и ServletResponse другому активному компоненту приложения.

Если relativeUrlPath начинается с "/", тогда специфицированный URL вычисляется относительно DOCROOT ServletContext'а для данной JSP.
Если путь не начинается с "/", специфицированный URL вычисляется относительно URL запроса, который был отображён в вызывающую JSP.

Верным является только вызов этого метода из Thread, выполняющегося внутри метода _jspService(...) в JSP.

После успешного вызова этого метода, для вызывающего Thread не разрешаются попытки модифицировать ServletResponse-объект. Любая такая попытка даёт непредсказуемое поведение. Обычно вызывающий, после вызова этого метода, немедленно возвращается из метода _jspService(...).

Параметры:

relativeUrlPath - специфицирует относительный путь URL к целевому ресурсу, как описано выше.

Вызывает:

javax.servlet.ServletException

java.io.IOException

java.lang.IllegalArgumentException - если URL целевого ресурса неразрешим.

java.lang.IllegalStateException - если ServletResponse не в том состоянии, когда перенаправление может быть выполнено.

java.lang.SecurityException - если целевой ресурс не может быть достигнут взывающим.

---

include

public abstract void include(java.lang.String relativeUrlPath)
                      throws javax.servlet.ServletException,
                             java.io.IOException

Вызывает обработку специфицированного ресурса как части текущих ServletRequest и ServletResponse, обрабатываемых вызывающим Thread. Вывод обрабатываемых запросом целевых ресурсов записывается непосредственно в поток вывода ServletResponse'а.

Текущий "out" JspWriter'а для данной JSP очищается, в качестве побочного эффекта этого вызова, до обработки include.

Если relativeUrlPath начинается с "/", специфицированный URL вычисляется относительно DOCROOT ServletContext'а для данной JSP.
Если путь не начинается с "/", специфицированный URL вычисляется относительно URL запроса, который был отображён в вызывающую JSP.

Верным является только вызов этого метода из Thread, выполняющегося внутри метода _jspService(...) в JSP.

Параметры:

relativeUrlPath - специфицирует относительный путь URL к включаемому целевому ресурсу.

Вызывает:

javax.servlet.ServletException

java.io.IOException

java.lang.IllegalArgumentException - если URL целевого ресурса неразрешим.

java.lang.SecurityException - если целевой ресурс не может быть достигнут взывающим.

---

handlePageException

public abstract void handlePageException(java.lang.Exception e)
                                  throws javax.servlet.ServletException,
                                         java.io.IOException

Этот метод предназначен для процессинга/обработки необработанного исключения уровня "page" путём перенаправления исключения специфицированной для данной JSP странице ошибок или, если ничего не было специфицировано, для выполнения какой-либо специфицированной реализацией акции.

Класс реализации JSP обычно должен будет зачистить локальный статус до вызова этого метода и сразу после этого возвратить управление. Недопустимой является генерация вывода клиенту или модификация статуса ServletResponse'а после вызова этого метода.

Этот метод сохранён для обеспечения обратной совместимости. Вновь генерируемый код должен использовать PageContext.handlePageException(Throwable).

Параметры:

e - обрабатываемое исключение.

Вызывает:

javax.servlet.ServletException

java.io.IOException

NullPointerException - если exception - null.

java.lang.SecurityException - если целевой ресурс не может быть достигнут взывающим.

См. также:

handlePageException(Throwable)

---

handlePageException

public abstract void handlePageException(java.lang.Throwable t)
                                  throws javax.servlet.ServletException,
                                         java.io.IOException

Этот метод идентичен методу handlePageException(Exception), за исключением того, что он принимает Throwable. Это предпочтительный метод для использования, так как он позволяет создавать соответствующую реализацию семантики errorpage.

Этот метод предназначен для процессинга/обработки необработанного исключения уровня "page" путём перенаправления исключения специфицированной для данной JSP странице ошибок или, если ничего не было специфицировано, для выполнения какой-либо специфицированной реализацией акции.

Класс реализации JSP обычно должен будет зачистить локальный статус до вызова этого метода и сразу после этого возвратить управление. Недопустимой является генерация вывода клиенту или модификация статуса ServletResponse'а после вызова этого метод.

Параметры:

t - обрабатываемый throwable.

Вызывает:

javax.servlet.ServletException

java.io.IOException

NullPointerException - если exception - null.

java.lang.SecurityException - если целевой ресурс не может быть достигнут взывающим.

См. также:

handlePageException(Exception)

---

pushBody

public BodyContent pushBody()

Возвращает новый BodyContent-объект, сохраняет текущий "out" JspWriter и обновляет значение атрибута "out" в пространстве имён области видимости page PageContext'а.

Возвращает:

новый BodyContent.

---

popBody

public JspWriter popBody()

Возвращает предыдущий JspWriter "out", сохранённый парным методом pushBody(), и обновляет значение атрибута "out" в пространстве имён области видимости page PageContext'а.

Возвращает:

сохранённый JspWriter.

---

Обзор   Пакет     Класс   Дерево   Не рекомендуются   Индекс   Справка
ПРЕДЫДУЩИЙ КЛАСС   СЛЕДУЮЩИЙ КЛАСС	ФРЭЙМЫ     БЕЗ ФРЭЙМОВ
РЕЗЮМЕ:  ВНУТРЕННИЙ | ПОЛЕ |  КОНСТРУКТОР | МЕТОД	ДЕТАЛИ:  ПОЛЕ | КОНСТРУКТОР  | МЕТОД

---

---

Обзор   Пакет     Класс   Дерево   Не рекомендуются   Индекс   Справка
ПРЕДЫДУЩИЙ КЛАСС     СЛЕДУЮЩИЙ КЛАСС	ФРЭЙМЫ     БЕЗ ФРЭЙМОВ
РЕЗЮМЕ:  ВНУТРЕННИЙ | ПОЛЕ |  КОНСТРУКТОР | МЕТОД	ДЕТАЛИ:  ПОЛЕ | КОНСТРУКТОР |  МЕТОД

---

javax.servlet.jsp.tagext
Класс PageData

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.PageData

---

public abstract class PageData

extends java.lang.Object

Информация времени трансляции о JSP-странице. Эта информация соответствует XML-просмотру JSP-страницы.

Объекты этого типа генерируются JSP-транслятором, например, когда передаются экземпляру TagLibraryValidator'а.

---

Конструктор. Резюме.

PageData ()

 

Метод. Резюме.
abstract  java.io.InputStream	getInputStream ()           Возвращает поток ввода в XML-просмотре JSP-страницы.

 

Методы, унаследованные из класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Конструктор. Детали.

PageData

public PageData()

Метод. Детали.

getInputStream

public abstract java.io.InputStream getInputStream()

Возвращает поток ввода в XML-просмотре JSP-страницы. Вызывает XML-просмотр JSP-страницы, имеющей развёрнутые директивы include.

Возвращает:

Поток ввода документа.

---

Обзор   Пакет     Класс   Дерево   Не рекомендуются   Индекс   Справка
ПРЕДЫДУЩИЙ КЛАСС     СЛЕДУЮЩИЙ КЛАСС	ФРЭЙМЫ     БЕЗ ФРЭЙМОВ
РЕЗЮМЕ:  ВНУТРЕННИЙ | ПОЛЕ |  КОНСТРУКТОР | МЕТОД	ДЕТАЛИ:  ПОЛЕ | КОНСТРУКТОР |  МЕТОД

---

---

Обзор   Пакет     Класс   Дерево   Не рекомендуется   Индекс   Справка
ПРЕДЫДУЩИЙ КЛАСС     СЛЕДУЮЩИЙ КЛАСС	ФРЭЙМ     БЕЗ ФРЭЙМОВ
РЕЗЮМЕ:  ВНУТРЕННИЙ | ПОЛЕ |  КОНСТРУКТОР | МЕТОД	ДЕТАЛИ:  ПОЛЕ |  КОНСТРУКТОР | МЕТОД

---

javax.servlet.jsp.tagext
Класс TagAttributeInfo

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagAttributeInfo

---

public class TagAttributeInfo

extends java.lang.Object

Информация об атрибутах Tag'а, доступных на этапе трансляции. Этот класс инстанциируется из Tag Library Descriptor-файла (TLD).

Сюда включается только информация, необходимая для генерации кода. Другая информация, наподобие SCHEMA для проверки, находится в других местах.

---

Поле. Резюме.
static java.lang.String	ID           "id" привязывается как ID.

 

Конструктор. Резюме.

TagAttributeInfo (java.lang.String name, boolean required, java.lang.String type, boolean reqTime)           Конструктор для TagAttributeInfo.

 

Метод. Резюме.
boolean	canBeRequestTime ()           Может ли данный атрибут содержать значение времени запроса.
static TagAttributeInfo	getIdAttribute (TagAttributeInfo[] a)           Удобный static-метод, проходящий по массиву TagAttributeInfo-объектов в поисках "id".
java.lang.String	getName ()           Имя данного атрибута.
java.lang.String	getTypeName ()           Тип (как String) данного атрибута.
boolean	isRequired ()           необходим ли данный атрибут.
java.lang.String	toString ()

 

Методы, унаследованные из класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Поле. Детали.

ID

public static final java.lang.String ID

"id" привязывается как ID. Нет никакого реального преимущества при использовании его как-нибудь ещё, так как IDREFs не обрабатываются иначе.

Конструктор. Детали.

TagAttributeInfo

public TagAttributeInfo(java.lang.String name,
                        boolean required,
                        java.lang.String type,
                        boolean reqTime)

Конструктор для TagAttributeInfo. Этот класс инстанциируется только из TagLibrary-кода по запросу из некоторого JSP-кода,разбирающего TLD (Tag Library Descriptor).

Параметры:

name - имя атрибута.

required - необходим ли атрибут в экземплярах тэга.

type - имя типа атрибута.

reqTime - содержит ли атрибут Attribute времени запроса.

Метод. Детали.

getName

public java.lang.String getName()

Имя данного атрибута.

Возвращает:

имя атрибута.

---

getTypeName

public java.lang.String getTypeName()

Тип (как String) данного атрибута.

Возвращает:

тип атрибута.

---

canBeRequestTime

public boolean canBeRequestTime()

Может ли атрибут содержать значение времени запроса.

Возвращает:

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

---

isRequired

public boolean isRequired()

Необходим ли/required атрибут.

Возвращает:

необходим ли атрибут.

---

getIdAttribute

public static TagAttributeInfo getIdAttribute(TagAttributeInfo[] a)

Удобный static-метод, проходящий по массиву TagAttributeInfo-объектов в поисках "id".

Параметры:

a - массив TagAttributeInfo.

Возвращает:

Ссылка на TagAttributeInfo с именем "id".

---

toString

public java.lang.String toString()

Переопределяет:

toString в классе java.lang.Object.

---

Обзор   Пакет     Класс   Дерево   Не рекомендуется   Индекс   Справка
ПРЕДЫДУЩИЙ КЛАСС     СЛЕДУЮЩИЙ КЛАСС	ФРЭЙМ     БЕЗ ФРЭЙМОВ
РЕЗЮМЕ:  ВНУТРЕННИЙ | ПОЛЕ |  КОНСТРУКТОР | МЕТОД	ДЕТАЛИ:  ПОЛЕ |  КОНСТРУКТОР | МЕТОД

---

Обзор   Пакет     Класс   Дерево   Не рекомендуется   Индекс   Справка
ПРЕДЫДУЩИЙ КЛАСС     СЛЕДУЮЩИЙ КЛАСС	ФРЭЙМ     БЕЗ ФРЭЙМОВ
РЕЗЮМЕ:  ВНУТРЕННИЙ| ПОЛЕ |  КОНСТРУКТОР | МЕТОД	ДЕТАЛИ:  ПОЛЕ |  КОНСТРУКТОР | МЕТОД

---

javax.servlet.jsp.tagext
Класс TagData

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagData

---

public class TagData

extends java.lang.Object

implements java.lang.Cloneable

Информация (только времени трансляции) пары attribute/value для экземпляра тэга.

TagData используется только в качестве аргумента методов isValid и getVariableInfo в of TagExtraInfo, которые вызываются на этапе трансляции.

---

Поле. Резюме.
static java.lang.Object	REQUEST_TIME_VALUE           Определённое значение атрибута для указания его значения в выражении времени запроса (которое ещё не доступно, поскольку экземпляры TagData используются на этапе трансляции).

 

Конструктор. Резюме.

TagData (java.util.Hashtable attrs)           Конструктор для TagData.

TagData (java.lang.Object[][] atts)           Конструктор для  TagData.

 

Метод. Резюме
java.lang.Object	getAttribute (java.lang.String attName)           Значение атрибута.
java.util.Enumeration	getAttributes ()           Перечисляет атрибуты.
java.lang.String	getAttributeString (java.lang.String attName)           Получает значение для данного атрибута.
java.lang.String	getId ()           Значение атрибута id, если доступно.
void	setAttribute (java.lang.String attName, java.lang.Object value)           Устанавливает значение атрибута.

 

Методы, унаследованные из класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Поле. Детали.

REQUEST_TIME_VALUE

public static final java.lang.Object REQUEST_TIME_VALUE

Определённое значение атрибута для указания его значения в выражении времени запроса (которое ещё не доступно, поскольку экземпляры TagData используются на этапе трансляции).

Конструктор. Детали.

TagData

public TagData(java.lang.Object[][] atts)

Конструктор для TagData.

Типичный конструктор выглядит так:

 static final Object[][] att = {{"connection", "conn0"}, {"id", "query0"}};
 static final TagData td = new TagData(att);
 

Все значения обязаны быть Strings, за исключением тех, которые содержат определённый объект REQUEST_TIME_VALUE.

Параметры:

atts - static-атрибут и значения. Может быть null.

---

TagData

public TagData(java.util.Hashtable attrs)

Конструктор для TagData. Если у Вас уже есть атрибуты в хэш-таблице, используйте этот конструктор.

Параметры:

attrs - хэш-таблица, из которой получать значения.

Метод. Детали.

getId

public java.lang.String getId()

Значение атрибута id, если имеется.

Возвращает:

значение атрибута id или null.

---

getAttribute

public java.lang.Object getAttribute(java.lang.String attName)

Значение атрибута. Возвращает определённый объект REQUEST_TIME_VALUE, если это значение времени запроса. Возвращает null, если атрибут не установлен.

Возвращает:

объект значения атрибута.

---

setAttribute

public void setAttribute(java.lang.String attName,
                         java.lang.Object value)

Устанавливает значение атрибута.

Параметры:

attName - имя атрибута.

value - значение.

---

getAttributeString

public java.lang.String getAttributeString(java.lang.String attName)

Получает значение данного атрибута.

Возвращает:

строковое значение атрибута.

---

getAttributes

public java.util.Enumeration getAttributes()

Перечисляет атрибуты.

Возвращает:

перечисление атрибутов в TagData.

---

Обзор   Пакет     Класс   Дерево   Не рекомендуется   Индекс   Справка
ПРЕДЫДУЩИЙ КЛАСС     СЛЕДУЮЩИЙ КЛАСС	ФРЭЙМ     БЕЗ ФРЭЙМОВ
РЕЗЮМЕ:  ВНУТРЕННИЙ| ПОЛЕ |  КОНСТРУКТОР | МЕТОД	ДЕТАЛИ:  ПОЛЕ |  КОНСТРУКТОР | МЕТОД

---

---

Обзор   Пакет     Класс   Дерево   Не рекомендуются   Индекс   Справка
ПРЕДЫДУЩИЙ КЛАСС     СЛЕДУЮЩИЙ КЛАСС	ФРЭЙМЫ     БЕЗ ФРЭЙМОВ
РЕЗЮМЕ:  ВНУТРЕННИЙ | ПОЛЕ |  КОНСТРУКТОР | МЕТОД	ДЕТАЛИ:  ПОЛЕ | КОНСТРУКТОР |  МЕТОД

---

javax.servlet.jsp.tagext
Класс TagExtraInfo

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagExtraInfo

---

public abstract class TagExtraInfo

extends java.lang.Object

Необязательный класс/Optional, предоставляемый автором библиотеки тэгов для описания дополнительной информации времени трансляции, не указанной в TLD. Класс TagExtraInfo упоминается в Tag Library Descriptor-файле (TLD).

Этот класс может использоваться:

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

JSP-транчлятор отвечает за то, чтобы начальное значение, возвращаемое вызовами getTagInfo(), соответствовало TagInfo-объекту для транслируемого тэга. Если выполняется явный вызов setTagInfo(), передаваемый объект будет возвращён последующими вызовами getTagInfo().

Единственный способ повлиять на значение, возвращаемое методом getTagInfo(), - через вызовы setTagInfo(), и, таким образом, TagExtraInfo.setTagInfo() вызывается JSP-транслятором TagInfo-объектом, который соответствует транслируемому тэгу. Вызов должен происходить до любого вызова метода isValid() и до любого вызова getVariableInfo().

---

Конструктор. Резюме.

TagExtraInfo ()

 

Метод. Резюме.
TagInfo	getTagInfo ()           Получает TagInfo для данного класса.
VariableInfo[]	getVariableInfo (TagData data)           Получает информацию о переменных скриптинга, определённых тэгом, ассоциированным с данным экземпляром TagExtraInfo.
boolean	isValid (TagData data)           Проверка атрибутов на этапе трансляции.
void	setTagInfo (TagInfo tagInfo)           Устанавливает TagInfo для данного класса.

 

Методы, унаследованные из класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Конструктор. Детали.

TagExtraInfo

public TagExtraInfo()

Метод. Детали.

getVariableInfo

public VariableInfo[] getVariableInfo(TagData data)

Получает информацию о переменных скриптинга, определённых тэгом, ассоциированным с данным экземпляром TagExtraInfo. Атрибуты времени запроса обозначены как таковые в параметре TagData.

Параметры:

data - TagData-экземпляр.

Возвращает:

Массив VariableInfo-данных.

---

isValid

public boolean isValid(TagData data)

Проверка атрибутов на этапе трансляции. Атрибуты времени запроса обозначены как таковые в параметре TagData.

Параметры:

data - TagData-экземпляр.

Возвращает:

верен ли данный экземпляр тэга.

---

setTagInfo

public final void setTagInfo(TagInfo tagInfo)

Устанавливает TagInfo для данного класса.

Параметры:

tagInfo - TagInfo, которого расширяет данный экземпляр.

---

getTagInfo

public final TagInfo getTagInfo()

Получает TagInfo для данного класса.

Возвращает:

TagInfo, которого расширяет данный экземпляр.

---

Обзор   Пакет     Класс   Дерево   Не рекомендуются   Индекс   Справка
ПРЕДЫДУЩИЙ КЛАСС     СЛЕДУЮЩИЙ КЛАСС	ФРЭЙМЫ     БЕЗ ФРЭЙМОВ
РЕЗЮМЕ:  ВНУТРЕННИЙ | ПОЛЕ |  КОНСТРУКТОР | МЕТОД	ДЕТАЛИ:  ПОЛЕ | КОНСТРУКТОР |  МЕТОД

---

---

Обзор   Пакет     Класс   Дерево   Не рекомендуются   Индекс   Справка
ПРЕДЫДУЩИЙ КЛАСС     СЛЕДУЮЩИЙ КЛАСС	ФРЭЙМЫ     БЕЗ ФРЭЙМОВ
РЕЗЮМЕ:  ВНУТРЕННИЙ | ПОЛЕ |  КОНСТРУКТОР | МЕТОД	ДЕТАЛИ:  ПОЛЕ |  КОНСТРУКТОР | МЕТОД

---

javax.servlet.jsp.tagext
Класс TagInfo

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagInfo

---

public class TagInfo

extends java.lang.Object

Tag-информация для тэга в Библиотеке Тэгов; Этот класс инстанциируется из Tag Library Descriptor-файла (TLD) и доступен только на этапе трансляции.

---

Поле. Резюме.
static java.lang.String	BODY_CONTENT_EMPTY           static-константа для getBodyContent(), если он пустой
static java.lang.String	BODY_CONTENT_JSP           static-константа для getBodyContent(), если он - JSP
static java.lang.String	BODY_CONTENT_TAG_DEPENDENT           static-константа для getBodyContent(), если он зависит от Tag'а

 

Конструктор. Резюме.

TagInfo (java.lang.String tagName, java.lang.String tagClassName, java.lang.String bodycontent, java.lang.String infoString, TagLibraryInfo taglib, TagExtraInfo tagExtraInfo, TagAttributeInfo[] attributeInfo)           Конструктор для TagInfo из данных в формате JSP 1.1 для TLD.

TagInfo (java.lang.String tagName, java.lang.String tagClassName, java.lang.String bodycontent, java.lang.String infoString, TagLibraryInfo taglib, TagExtraInfo tagExtraInfo, TagAttributeInfo[] attributeInfo, java.lang.String displayName, java.lang.String smallIcon, java.lang.String largeIcon, TagVariableInfo[] tvi)           Конструктор для TagInfo из данных в формате JSP 1.2 для TLD.

 

Метод. Резюме.
TagAttributeInfo[]	getAttributes ()           Информация атрибута (в TLD) данного тэга.
java.lang.String	getBodyContent ()           Информация bodycontent для данного тэга.
java.lang.String	getDisplayName ()           Получает displayName
java.lang.String	getInfoString ()           Строка информации для тэга.
java.lang.String	getLargeIcon ()           Получает путь к большой иконке.
java.lang.String	getSmallIcon ()           Получает путь к маленькой иконке.
java.lang.String	getTagClassName ()           Имя класса, предоставляющего обработчик для данного тэга.
TagExtraInfo	getTagExtraInfo ()           Экземпляр (если имеется) для дополнительной информации тэга.
TagLibraryInfo	getTagLibrary ()           Экземпляр TabLibraryInfo, к которому принадлежим.
java.lang.String	getTagName ()           Имя Tag'а.
TagVariableInfo[]	getTagVariableInfos ()           Получает Get TagVariableInfo-объекты, ассоциированные с данным TagInfo.
VariableInfo[]	getVariableInfo (TagData data)           Информация об объектах скриптинга, созданных этим тэгом на этапе прогона.
boolean	isValid (TagData data)           Проверка атрибутов на этапе трансляции.
void	setTagExtraInfo (TagExtraInfo tei)           Устанавливает экземпляр для дополнительной информации тэга.
void	setTagLibrary (TagLibraryInfo tl)           Устанавливает свойство TagLibraryInfo.
java.lang.String	toString ()           Строго для целей отладки ...

 

Методы, унаследованные из класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Поле. Детали.

BODY_CONTENT_JSP

public static final java.lang.String BODY_CONTENT_JSP

static-константа для getBodyContent(), когда он - JSP.

---

BODY_CONTENT_TAG_DEPENDENT

public static final java.lang.String BODY_CONTENT_TAG_DEPENDENT

static-константа для getBodyContent(), когда он зависит от Tag'а.

---

BODY_CONTENT_EMPTY

public static final java.lang.String BODY_CONTENT_EMPTY

static-константа для getBodyContent(), когда он пустой.

Конструктор. Детали.

TagInfo

public TagInfo(java.lang.String tagName,
               java.lang.String tagClassName,
               java.lang.String bodycontent,
               java.lang.String infoString,
               TagLibraryInfo taglib,
               TagExtraInfo tagExtraInfo,
               TagAttributeInfo[] attributeInfo)

Конструктор для TagInfo из данных в формате JSP 1.1 для TLD. Этот класс инстанциируется только из кода TagLibrary по запросу некоторого кода JSP, который разбирает TLD (Tag Library Descriptor). Обратите внимание, что, поскольку TagLibibraryInfo отражает информацию и TLD, и директивы taglib, экземпляр TagInfo зависит от директивы taglib. Возможно, это ошибка дизайна, которая будет устранена в будущем.

Параметры:

tagName - имя данного тэга;

tagClassName - имя класса обработчика тэга;

bodycontent - информация содержимого тела этих тэгов;

infoString - строка (optional) информации для данного тэга;

taglib - экземпляр библиотеки тэгов, содержащей нас;

tagExtraInfo - экземпляр, предоставляющий дополнительную информацию Tag'а. Может быть null;

attributeInfo - массив AttributeInfo-данных из дескриптора. Может быть null.

---

TagInfo

public TagInfo(java.lang.String tagName,
               java.lang.String tagClassName,
               java.lang.String bodycontent,
               java.lang.String infoString,
               TagLibraryInfo taglib,
               TagExtraInfo tagExtraInfo,
               TagAttributeInfo[] attributeInfo,
               java.lang.String displayName,
               java.lang.String smallIcon,
               java.lang.String largeIcon,
               TagVariableInfo[] tvi)

Конструктор для TagInfo из данных в формате JSP 1.2 для TLD. Этот класс инстанциируется только из кода TagLibrary по запросу некоторого кода JSP, который разбирает TLD (Tag Library Descriptor). Обратите внимание, что, поскольку TagLibibraryInfo отражает информацию и TLD, и директивы taglib, экземпляр TagInfo зависит от директивы taglib. Возможно, это ошибка дизайна, которая будет устранена в будущем.

Параметры:

tagName - имя данного тэга;

tagClassName - имя класса обработчика тэга;

bodycontent - информация содержимого тела этих тэгов;

infoString - строка (optional) информации для данного тэга;

taglib - экземпляр библиотеки тэгов, содержащей нас;

tagExtraInfo - экземпляр, предоставляющий дополнительную информацию Tag'а. Может быть null;

attributeInfo - массив AttributeInfo-данных из дескриптора. Может быть null;

displayName - краткое имя, отображаемое утилитами;

smallIcon - путь к небольшой иконке, отображаемой утилитами;

largeIcon - путь к большой иконке, отображаемой утилитами;

tagVariableInfo - массив TagVariableInfo (или null).

Метод. Детали.

getTagName

public java.lang.String getTagName()

Имя Tag'а.

Возвращает:

имя (краткое) тэга.

---

getAttributes

public TagAttributeInfo[] getAttributes()

Информация атрибута (в TLD) данного тэга. Значение return - это массив, описывающий атрибуты данного тэга, как указано в TLD. Нулевой return означает отсутствие атрибутов.

Возвращает:

массив TagAttributeInfo данного тэга.

---

getVariableInfo

public VariableInfo[] getVariableInfo(TagData data)

Информация об объектах скриптинга, созданных данным тэгом на этапе прогона.
Это удобный метод ассоциированного TagExtraInfo-класса.

По умолчанию null, если тэг не имеет атрибута "id", иначе -  {"id", Object}

Параметры:

data - TagData, описывающий данную акцию .

Возвращает:

Массив VariableInfo-элементов.

---

isValid

public boolean isValid(TagData data)

Проверка атрибутов на этапе трансляции. Это удобный метод ассоциированного TagExtraInfo-класса.

Параметры:

data - экземпляр TagData времени трансляции.

Возвращает:

верны ли данные.

---

setTagExtraInfo

public void setTagExtraInfo(TagExtraInfo tei)

Устанавливает экземпляр для дополнительной информации тэга.

Параметры:

tei - экземпляр TagExtraInfo.

---

getTagExtraInfo

public TagExtraInfo getTagExtraInfo()

Экземпляр (если имеется) для дополнительной информации тэга.

Возвращает:

экземпляр TagExtraInfo, если имеется.

---

getTagClassName

public java.lang.String getTagClassName()

Имя класса, предоставляющего обработчик для данного тэга.

Возвращает:

имя класса обработчика тэга.

---

getBodyContent

public java.lang.String getBodyContent()

Информация bodycontent для данного тэга.

Возвращает:

строку содержимого тела.

---

getInfoString

public java.lang.String getInfoString()

Строка информации для данного тэга.

Возвращает:

info-строку.

---

setTagLibrary

public void setTagLibrary(TagLibraryInfo tl)

Устанавливает свойство TagLibraryInfo. Заметьте, что элемент TagLibraryInfo зависит не только от информации TLD, но также и от специфики используемого экземпляра taglib. Это значит, что большое количество работы понадобится для конструирования и инициализации TagLib-объектов.
Если используется осторожно, этот setter поможет исключить необходимость создания новых элементов TagInfo для каждой директивы taglib.

Параметры:

tl - TagLibraryInfo для назначения.

---

getTagLibrary

public TagLibraryInfo getTagLibrary()

Экземпляр TabLibraryInfo, к которому мы (?) принадлежим.

Возвращает:

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

---

getDisplayName

public java.lang.String getDisplayName()

Получает displayName.

Возвращает:

краткое имя, отображаемое утилитами.

---

getSmallIcon

public java.lang.String getSmallIcon()

Получает путь к маленькой иконке.

Возвращает:

путь к маленькой иконке, отображаемой утилитами.

---

getLargeIcon

public java.lang.String getLargeIcon()

Получает путь к большой иконке.

Возвращает:

путь к большой иконке, отображаемой утилитами.

---

getTagVariableInfos

public TagVariableInfo[] getTagVariableInfos()

Получает TagVariableInfo-объекты, ассоциированные с данным TagInfo.

Возвращает:

TagVariableInfo-объекты, ассоциированные с данным TagInfo.

---

toString

public java.lang.String toString()

Строго для целей отладки ...

Переопределяет:

toString в классе java.lang.Object.

---

Обзор   Пакет     Класс   Дерево   Не рекомендуются   Индекс   Справка
ПРЕДЫДУЩИЙ КЛАСС     СЛЕДУЮЩИЙ КЛАСС	ФРЭЙМЫ     БЕЗ ФРЭЙМОВ
РЕЗЮМЕ:  ВНУТРЕННИЙ | ПОЛЕ |  КОНСТРУКТОР | МЕТОД	ДЕТАЛИ:  ПОЛЕ |  КОНСТРУКТОР | МЕТОД

---

---

Обзор   Пакет     Класс   Дерево   Не рекомендуются   Индекс   Справка
ПРЕДЫДУЩИЙ КЛАСС     СЛЕДУЮЩИЙ КЛАСС	ФРЭЙМЫ     БЕЗ ФРЭЙМОВ
РЕЗЮМЕ:  ВНУТРЕННИЙ | ПОЛЕ |  КОНСТРУКТОР | МЕТОД	ДЕТАЛИ:  ПОЛЕ |  КОНСТРУКТОР | МЕТОД

---

javax.servlet.jsp.tagext
Класс TagLibraryInfo

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagLibraryInfo

---

public abstract class TagLibraryInfo

extends java.lang.Object

Информация этапа трансляции, ассоциированная с директивой taglib, и лежащий в её основе TLD-файл. Большая часть информации - непосредственно из TLD, за исключением значений prefix и uri, используемых в директиве taglib.

---

Поле. Резюме.
protected  java.lang.String	info
protected  java.lang.String	jspversion
protected  java.lang.String	prefix
protected  java.lang.String	shortname
protected  TagInfo[]	tags
protected  java.lang.String	tlibversion
protected  java.lang.String	uri
protected  java.lang.String	urn

 

Конструктор. Резюме.
protected	TagLibraryInfo (java.lang.String prefix, java.lang.String uri)           Конструктор.

 

Метод. Резюме.
java.lang.String	getInfoString ()           Информация (документация) для данного TLD.
java.lang.String	getPrefixString ()           Префикс, назначенный данной taglib.
java.lang.String	etReliableURN ()           "Надёжное" URN, указанное в TLD.
java.lang.String	getRequiredVersion ()           Строка, описывающая необходимую версию JSP-контейнера.
java.lang.String	getShortName ()           Предпочтительное краткое имя (prefix/префикс), как указано в TLD.
TagInfo	getTag (java.lang.String shortname)           Получает TagInfo для данного имени тэга, просматривая все тэги в данной библиотеке тэгов.
TagInfo[]	getTags ()           Массив, описывающий тэги, определённые данной библиотекой тэгов.
java.lang.String	getURI ()           Значение атрибута uri.

<%taglib directive%>