src/javax/xml/transform/Templates.java

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


  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;
  27 
  28 import java.util.Properties;
  29 
  30 
  31 
  32 
  33 /**
  34  * An object that implements this interface is the runtime representation of processed
  35  * transformation instructions.
  36  *
  37  * <p>Templates must be threadsafe for a given instance
  38  * over multiple threads running concurrently, and may
  39  * be used multiple times in a given session.</p>


  40  */
  41 public interface Templates {
  42 
  43     /**
  44      * Create a new transformation context for this Templates object.
  45      *
  46      * @return A valid non-null instance of a Transformer.
  47      *
  48      * @throws TransformerConfigurationException if a Transformer can not be created.
  49      */
  50     Transformer newTransformer() throws TransformerConfigurationException;
  51 
  52     /**
  53      * Get the properties corresponding to the effective xsl:output element.
  54      * The object returned will
  55      * be a clone of the internal values. Accordingly, it can be mutated
  56      * without mutating the Templates object, and then handed in to
  57      * {@link javax.xml.transform.Transformer#setOutputProperties}.
  58      *
  59      * <p>The properties returned should contain properties set by the stylesheet,




  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;
  27 
  28 import java.util.Properties;
  29 
  30 
  31 
  32 
  33 /**
  34  * An object that implements this interface is the runtime representation of processed
  35  * transformation instructions.
  36  *
  37  * <p>Templates must be threadsafe for a given instance
  38  * over multiple threads running concurrently, and may
  39  * be used multiple times in a given session.</p>
  40  *
  41  * @since 1.4
  42  */
  43 public interface Templates {
  44 
  45     /**
  46      * Create a new transformation context for this Templates object.
  47      *
  48      * @return A valid non-null instance of a Transformer.
  49      *
  50      * @throws TransformerConfigurationException if a Transformer can not be created.
  51      */
  52     Transformer newTransformer() throws TransformerConfigurationException;
  53 
  54     /**
  55      * Get the properties corresponding to the effective xsl:output element.
  56      * The object returned will
  57      * be a clone of the internal values. Accordingly, it can be mutated
  58      * without mutating the Templates object, and then handed in to
  59      * {@link javax.xml.transform.Transformer#setOutputProperties}.
  60      *
  61      * <p>The properties returned should contain properties set by the stylesheet,