Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.infohazard.maverick.flow
Interface TransformStep  view TransformStep download TransformStep.java

All Known Implementing Classes:
LastStep

public interface TransformStep

The TransformStep defines a transformation step in a single request. It is used and then disposed of. It provides convenient facades for most of the usual output mechanisms that views and previous transforms might want. Unlike a Transform, a TransformStep is used in a single request and then thrown away.


Method Summary
 void done()
          This should be called after writing is complete.
 javax.servlet.http.HttpServletResponse getResponse()
          Must call done() when finished.
 org.xml.sax.ContentHandler getSAXHandler()
          Must call done() when finished.
 java.io.Writer getWriter()
          Must call done() when finished.
 void go(java.io.Reader input)
          This is available if it is more convenient.
 void go(javax.xml.transform.Source input)
          This is available if it is more convenient.
 void go(java.lang.String input)
          This is available if it is more convenient.
 boolean isLast()
          Your steps should always return false.
 void setContentType(java.lang.String contentType)
          This method allows content-type information to be passed into the subsequent step.
 

Method Detail

isLast

public boolean isLast()
Your steps should always return false. The last step, which is not really a step at all - it's the real output stream, will return true.


setContentType

public void setContentType(java.lang.String contentType)
This method allows content-type information to be passed into the subsequent step. It is equivalent to getResponse().setContentType(), however it can be used for all the other output methods (which do not provide a HttpServletResponse interface. Calling this method is optional but recommended so that prematurely halted transformations can have an intelligently set content-type.


getSAXHandler

public org.xml.sax.ContentHandler getSAXHandler()
                                         throws java.io.IOException,
                                                javax.servlet.ServletException
Must call done() when finished.


getResponse

public javax.servlet.http.HttpServletResponse getResponse()
                                                   throws java.io.IOException,
                                                          javax.servlet.ServletException
Must call done() when finished.


getWriter

public java.io.Writer getWriter()
                         throws java.io.IOException,
                                javax.servlet.ServletException
Must call done() when finished.


done

public void done()
          throws java.io.IOException,
                 javax.servlet.ServletException
This should be called after writing is complete.


go

public void go(javax.xml.transform.Source input)
        throws java.io.IOException,
               javax.servlet.ServletException
This is available if it is more convenient.


go

public void go(java.io.Reader input)
        throws java.io.IOException,
               javax.servlet.ServletException
This is available if it is more convenient.


go

public void go(java.lang.String input)
        throws java.io.IOException,
               javax.servlet.ServletException
This is available if it is more convenient.