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

NO_BUFFER

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

DEFAULT_BUFFER

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

UNBOUNDED_BUFFER

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

bufferSize

autoFlush

JspWriter

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

newLine

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

Вызывает:

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

print

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

Параметры:

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

Вызывает:

java.io.IOException

print

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

Параметры:

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

Вызывает:

java.io.IOException

print

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

Параметры:

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

Вызывает:

java.io.IOException

См. также:

java.lang.Integer#toString(int)

print

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

Параметры:

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

Вызывает:

java.io.IOException -  

См. также:

java.lang.Long#toString(long)

print

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

Параметры:

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

Вызывает:

java.io.IOException

См. также:

java.lang.Float#toString(float)

print

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

Параметры:

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

Вызывает:

java.io.IOException

См. также:

java.lang.Double#toString(double)

print

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

параметры:

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

Вызывает:

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

java.io.IOException

print

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

Параметры:

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

Вызывает:

java.io.IOException

print

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

Параметры:

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

Вызывает:

java.io.IOException

См. также:

Object.toString()

println

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

Вызывает:

java.io.IOException

println

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

Вызывает:

java.io.IOException

println

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

Вызывает:

java.io.IOException

println

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

Вызывает:

java.io.IOException

println

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

Вызывает:

java.io.IOException

println

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

Вызывает:

java.io.IOException

println

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

Вызывает:

java.io.IOException

println

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

Вызывает:

java.io.IOException

println

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

Вызывает:

java.io.IOException

println

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

Вызывает:

java.io.IOException

clear

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

Вызывает:

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

clearBuffer

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

Вызывает:

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

flush

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

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

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

Вызывает:

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

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

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

close

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

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

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

Вызывает:

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

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

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

getBufferSize

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

Возвращает:

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

getRemaining

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

Возвращает:

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

isAutoFlush

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

Возвращает:

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