Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.faces.context
Class PartialResponseWriter

    java.lang.Object
      java.io.Writer
          javax.faces.context.ResponseWriter
              javax.faces.context.ResponseWriterWrapper
                  javax.faces.context.PartialResponseWriter

All Implemented Interfaces:
  java.io.Closeable, java.io.Flushable, java.lang.Appendable, FacesWrapper<ResponseWriter>

    public class PartialResponseWriter

extends ResponseWriterWrapper

PartialResponseWriter decorates an existing `ResponseWriter` to support the generation of a partial response suitable for Ajax operations. In addition to the markup generation methods inherited from `javax.faces.context.ResponseWriter`, this class provides methods for constructing the standard partial response elements.

Since:
  2.0

Field Summary
`static java.lang.String` | `RENDER_ALL_MARKER` Reserved ID value to indicate entire ViewRoot.
`static java.lang.String` | `VIEW_STATE_MARKER` Reserved ID value to indicate serialized ViewState.

Fields inherited from class java.io.Writer
`lock`

Constructor Summary
`PartialResponseWriter(ResponseWriter writer)` Create a `PartialResponseWriter`.

Method Summary
`void` | `delete(java.lang.String targetId)` Write a delete operation.
`void` | `endDocument()` Write the end of a partial response.
`void` | `endError()` Write the end of an error.
`void` | `endEval()` Write the end of an eval operation.
`void` | `endExtension()` Write the end of an extension operation.
`void` | `endInsert()` Write the end of an insert operation.
`void` | `endUpdate()` Write the end of an update operation.
`ResponseWriter` | `getWrapped()` Return the wrapped `ResponseWriter` instance.
`void` | `redirect(java.lang.String url)` Write a redirect operation.
`void` | `startDocument()` Write the start of a partial response.
`void` | `startError(java.lang.String errorName)` Write the start of an error.
`void` | `startEval()` Write the start of an eval operation.
`void` | `startExtension(java.util.Map<java.lang.String,java.lang.String> attributes)` Write the start of an extension operation.
`void` | `startInsertAfter(java.lang.String targetId)` Write the start of an insert operation where the contents will be inserted after the specified target node.
`void` | `startInsertBefore(java.lang.String targetId)` Write the start of an insert operation where the contents will be inserted before the specified target node.
`void` | `startUpdate(java.lang.String targetId)` Write the start of an update operation.
`void` | `updateAttributes(java.lang.String targetId, java.util.Map<java.lang.String,java.lang.String> attributes)` Write an attribute update operation.

Methods inherited from class javax.faces.context.ResponseWriterWrapper
`cloneWithWriter, close, endCDATA, endElement, flush, getCharacterEncoding, getContentType, startCDATA, startElement, write, writeAttribute, writeComment, writeText, writeText, writeText, writeURIAttribute`

Methods inherited from class java.io.Writer
`append, append, append, write, write, write, write`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### RENDER_ALL_MARKER

    public static final java.lang.String RENDER_ALL_MARKER

  Reserved ID value to indicate entire ViewRoot.

  Since:
    2.0
  See Also:
    Constant Field Values

### VIEW_STATE_MARKER

    public static final java.lang.String VIEW_STATE_MARKER

  Reserved ID value to indicate serialized ViewState.

  Since:
    2.0
  See Also:
    Constant Field Values

Constructor Detail

### PartialResponseWriter

    public PartialResponseWriter(ResponseWriter writer)

  Create a `PartialResponseWriter`.

  Parameters:
    `writer` - The writer to wrap.
  Since:
    2.0

Method Detail

### getWrapped

    public ResponseWriter getWrapped()

  Return the wrapped `ResponseWriter` instance.

  Specified by:
    `getWrapped` in interface `FacesWrapper<ResponseWriter>`
  Specified by:
    `getWrapped` in class `ResponseWriterWrapper`
  Since:
    2.0
  See Also:
    `ResponseWriterWrapper.getWrapped()`

### startDocument

    public void startDocument()
                       throws java.io.IOException

  Write the start of a partial response.

  Overrides:
    `startDocument` in class `ResponseWriterWrapper`
  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0
  See Also:
    `ResponseWriter.startDocument()`

### endDocument

    public void endDocument()
                     throws java.io.IOException

  Write the end of a partial response.

  Overrides:
    `endDocument` in class `ResponseWriterWrapper`
  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0
  See Also:
    `ResponseWriter.endDocument()`

### startInsertBefore

    public void startInsertBefore(java.lang.String targetId)
                           throws java.io.IOException

  Write the start of an insert operation where the contents will be inserted before the specified target node.

  Parameters:
    `targetId` - ID of the node insertion should occur before
  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

### startInsertAfter

    public void startInsertAfter(java.lang.String targetId)
                          throws java.io.IOException

  Write the start of an insert operation where the contents will be inserted after the specified target node.

  Parameters:
    `targetId` - ID of the node insertion should occur after
  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

### endInsert

    public void endInsert()
                   throws java.io.IOException

  Write the end of an insert operation.

  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

### startUpdate

    public void startUpdate(java.lang.String targetId)
                     throws java.io.IOException

  Write the start of an update operation.

  Parameters:
    `targetId` - ID of the node to be updated
  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

### endUpdate

    public void endUpdate()
                   throws java.io.IOException

  Write the end of an update operation.

  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

### updateAttributes

    public void updateAttributes(java.lang.String targetId,
                                 java.util.Map<java.lang.String,java.lang.String> attributes)
                          throws java.io.IOException

  Write an attribute update operation.

  Parameters:
    `targetId` - ID of the node to be updated
    `attributes` - Map of attribute name/value pairs to be updated
  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

### delete

    public void delete(java.lang.String targetId)
                throws java.io.IOException

  Write a delete operation.

  Parameters:
    `targetId` - ID of the node to be deleted
  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

### redirect

    public void redirect(java.lang.String url)
                  throws java.io.IOException

  Write a redirect operation.

  Parameters:
    `url` - URL to redirect to
  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

### startEval

    public void startEval()
                   throws java.io.IOException

  Write the start of an eval operation.

  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

### endEval

    public void endEval()
                 throws java.io.IOException

  Write the end of an eval operation.

  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

### startExtension

    public void startExtension(java.util.Map<java.lang.String,java.lang.String> attributes)
                        throws java.io.IOException

  Write the start of an extension operation.

  Parameters:
    `attributes` - String name/value pairs for extension element attributes
  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

### endExtension

    public void endExtension()
                      throws java.io.IOException

  Write the end of an extension operation.

  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

### startError

    public void startError(java.lang.String errorName)
                    throws java.io.IOException

  Write the start of an error.

  Parameters:
    `errorName` - Descriptive string for the error
  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

### endError

    public void endError()
                  throws java.io.IOException

  Write the end of an error.

  Throws:
    `java.io.IOException` - if an input/output error occurs
  Since:
    2.0

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2002-2010 Oracle America Inc, Inc. All Rights Reserved.