VelocityWriter (bboss-velocity 6.1.5 API)

java.lang.Object
- java.io.Writer
- - bboss.org.apache.velocity.io.VelocityWriter

所有已实现的接口:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable
```
public final class VelocityWriter
extends java.io.Writer
```
Implementation of a fast Writer. It was originally taken from JspWriter and modified to have less syncronization going on.

字段概要

字段
限定符和类型	字段和说明
`static int`	`DEFAULT_BUFFER` constant indicating that the Writer is buffered and is using the implementation default buffer size
`static int`	`NO_BUFFER` constant indicating that the Writer is not buffering output
`static int`	`UNBOUNDED_BUFFER` constant indicating that the Writer is buffered and is unbounded; this is used in BodyContent

从类继承的字段 java.io.Writer
lock

构造器概要

构造器
构造器和说明
`VelocityWriter(java.io.Writer writer)` Create a buffered character-output stream that uses a default-sized output buffer.
`VelocityWriter(java.io.Writer writer, int sz, boolean autoFlush)` Create a new buffered character-output stream that uses an output buffer of the given size.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`clear()` Discard the output buffer.
`void`	`close()` Close the stream.
`void`	`flush()` Flush the stream.
`int`	`getBufferSize()` This method returns the size of the buffer used by the JspWriter.
`int`	`getRemaining()`
`boolean`	`isAutoFlush()` This method indicates whether the JspWriter is autoFlushing.
`void`	`recycle(java.io.Writer writer)` resets this class so that it can be reused
`void`	`write(char[] buf)` Write an array of characters.
`void`	`write(char[] cbuf, int off, int len)` Write a portion of an array of characters.
`void`	`write(int c)` Write a single character.
`void`	`write(java.lang.String s)` Write a string.
`void`	`write(java.lang.String s, int off, int len)` Write a portion of a String.

从类继承的方法 java.io.Writer
append, append, append

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - NO_BUFFER
```
public static final int NO_BUFFER
```
    constant indicating that the Writer is not buffering output
    
    另请参阅:
    
    常量字段值
  - DEFAULT_BUFFER
```
public static final int DEFAULT_BUFFER
```
    constant indicating that the Writer is buffered and is using the implementation default buffer size
    
    另请参阅:
    
    常量字段值
  - UNBOUNDED_BUFFER
```
public static final int UNBOUNDED_BUFFER
```
    constant indicating that the Writer is buffered and is unbounded; this is used in BodyContent
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - VelocityWriter
```
public VelocityWriter(java.io.Writer writer)
```
    Create a buffered character-output stream that uses a default-sized output buffer.
    
    参数:
    
    writer - Writer to wrap around
  - VelocityWriter
```
public VelocityWriter(java.io.Writer writer,
                      int sz,
                      boolean autoFlush)
```
    Create a new buffered character-output stream that uses an output buffer of the given size.
    
    参数:
    
    writer - Writer to wrap around
    
    sz - Output-buffer size, a positive integer
    
    autoFlush -
    
    抛出:
    
    java.lang.IllegalArgumentException - If sz is <= 0
- 方法详细资料
  - getBufferSize
```
public int getBufferSize()
```
    This method returns the size of the buffer used by the JspWriter.
    
    返回:
    
    the size of the buffer in bytes, or 0 is unbuffered.
  - isAutoFlush
```
public boolean isAutoFlush()
```
    This method indicates whether the JspWriter is autoFlushing.
    
    返回:
    
    if this JspWriter is auto flushing or throwing IOExceptions on buffer overflow conditions
  - clear
```
public final void clear()
```
    Discard the output buffer.
  - flush
```
public final void flush()
                 throws java.io.IOException
```
    Flush the stream.
    
    指定者:
    
    flush 在接口中 java.io.Flushable
    
    指定者:
    
    flush 在类中 java.io.Writer
    
    抛出:
    
    java.io.IOException
  - close
```
public final void close()
                 throws java.io.IOException
```
    Close the stream.
    
    指定者:
    
    close 在接口中 java.io.Closeable
    
    指定者:
    
    close 在接口中 java.lang.AutoCloseable
    
    指定者:
    
    close 在类中 java.io.Writer
    
    抛出:
    
    java.io.IOException
  - getRemaining
```
public final int getRemaining()
```
    返回:
    
    the number of bytes unused in the buffer
  - write
```
public final void write(int c)
                 throws java.io.IOException
```
    Write a single character.
    
    覆盖:
    
    write 在类中 java.io.Writer
    
    参数:
    
    c -
    
    抛出:
    
    java.io.IOException
  - write
```
public final void write(char[] cbuf,
                        int off,
                        int len)
                 throws java.io.IOException
```
    Write a portion of an array of characters.
    Ordinarily this method stores characters from the given array into this stream's buffer, flushing the buffer to the underlying stream as needed. If the requested length is at least as large as the buffer, however, then this method will flush the buffer and write the characters directly to the underlying stream. Thus redundant DiscardableBufferedWriters will not copy data unnecessarily.
    
    指定者:
    
    write 在类中 java.io.Writer
    
    参数:
    
    cbuf - A character array
    
    off - Offset from which to start reading characters
    
    len - Number of characters to write
    
    抛出:
    
    java.io.IOException
  - write
```
public final void write(char[] buf)
                 throws java.io.IOException
```
    Write an array of characters. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.
    
    覆盖:
    
    write 在类中 java.io.Writer
    
    参数:
    
    buf -
    
    抛出:
    
    java.io.IOException
  - write
```
public final void write(java.lang.String s,
                        int off,
                        int len)
                 throws java.io.IOException
```
    Write a portion of a String.
    
    覆盖:
    
    write 在类中 java.io.Writer
    
    参数:
    
    s - String to be written
    
    off - Offset from which to start reading characters
    
    len - Number of characters to be written
    
    抛出:
    
    java.io.IOException
  - write
```
public final void write(java.lang.String s)
                 throws java.io.IOException
```
    Write a string. This method cannot be inherited from the Writer class because it must suppress I/O exceptions.
    
    覆盖:
    
    write 在类中 java.io.Writer
    
    参数:
    
    s -
    
    抛出:
    
    java.io.IOException
  - recycle
```
public final void recycle(java.io.Writer writer)
```
    resets this class so that it can be reused
    
    参数:
    
    writer -

类 VelocityWriter

字段概要

从类继承的字段 java.io.Writer

构造器概要

方法概要

从类继承的方法 java.io.Writer

从类继承的方法 java.lang.Object

字段详细资料

NO_BUFFER

DEFAULT_BUFFER

UNBOUNDED_BUFFER

构造器详细资料

VelocityWriter

VelocityWriter

方法详细资料

getBufferSize

isAutoFlush

clear

flush

close

getRemaining

write

write

write

write

write

recycle