src/javax/xml/transform/sax/TemplatesHandler.java

Print this page
rev 602 : 8047723: @since tag cleanup in jaxp
Reviewed-by:


  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.xml.transform.sax;
  27 
  28 import javax.xml.transform.*;
  29 
  30 import org.xml.sax.ContentHandler;
  31 
  32 /**
  33  * A SAX ContentHandler that may be used to process SAX
  34  * parse events (parsing transformation instructions) into a Templates object.
  35  *
  36  * <p>Note that TemplatesHandler does not need to implement LexicalHandler.</p>


  37  */
  38 public interface TemplatesHandler extends ContentHandler {
  39 
  40     /**
  41      * When a TemplatesHandler object is used as a ContentHandler
  42      * for the parsing of transformation instructions, it creates a Templates object,
  43      * which the caller can get once the SAX events have been completed.
  44      *
  45      * @return The Templates object that was created during
  46      * the SAX event process, or null if no Templates object has
  47      * been created.
  48      *
  49      */
  50     public Templates getTemplates();
  51 
  52     /**
  53      * Set the base ID (URI or system ID) for the Templates object
  54      * created by this builder.  This must be set in order to
  55      * resolve relative URIs in the stylesheet.  This must be
  56      * called before the startDocument event.


  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.xml.transform.sax;
  27 
  28 import javax.xml.transform.*;
  29 
  30 import org.xml.sax.ContentHandler;
  31 
  32 /**
  33  * A SAX ContentHandler that may be used to process SAX
  34  * parse events (parsing transformation instructions) into a Templates object.
  35  *
  36  * <p>Note that TemplatesHandler does not need to implement LexicalHandler.</p>
  37  *
  38  * @since 1.4
  39  */
  40 public interface TemplatesHandler extends ContentHandler {
  41 
  42     /**
  43      * When a TemplatesHandler object is used as a ContentHandler
  44      * for the parsing of transformation instructions, it creates a Templates object,
  45      * which the caller can get once the SAX events have been completed.
  46      *
  47      * @return The Templates object that was created during
  48      * the SAX event process, or null if no Templates object has
  49      * been created.
  50      *
  51      */
  52     public Templates getTemplates();
  53 
  54     /**
  55      * Set the base ID (URI or system ID) for the Templates object
  56      * created by this builder.  This must be set in order to
  57      * resolve relative URIs in the stylesheet.  This must be
  58      * called before the startDocument event.