You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by dl...@apache.org on 2001/02/02 20:00:04 UTC

cvs commit: xml-xalan/java/compat_src/org/apache/xalan/xslt XSLTInputSource.java

dleslie     01/02/02 11:00:03

  Modified:    java/compat_src/org/apache/xalan/xslt XSLTInputSource.java
  Log:
  Fixed javadoc for api that was just added back.
  
  Revision  Changes    Path
  1.4       +30 -7     xml-xalan/java/compat_src/org/apache/xalan/xslt/XSLTInputSource.java
  
  Index: XSLTInputSource.java
  ===================================================================
  RCS file: /home/cvs/xml-xalan/java/compat_src/org/apache/xalan/xslt/XSLTInputSource.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- XSLTInputSource.java	2001/02/02 18:00:29	1.3
  +++ XSLTInputSource.java	2001/02/02 18:59:59	1.4
  @@ -84,9 +84,12 @@
     
     /**
       * Zero-argument default constructor -- Before you can use the new XSLTInputSource object in a transformation,
  -    * you must define the document source with setSystemId().
  +    * you must define the document source with setSystemId(), setNode(), setInputStream(), or setCharacterStream().
       *
       * @see #setSystemId(String)
  +    * @see #setNode(Node)
  +    * @see #setInputStream
  +    * @see #setCharacterStream
       * @see #setEncoding(String)
       */
     public XSLTInputSource ()
  @@ -101,9 +104,14 @@
   
       * If the system identifier is a URL, it must be fully resolved.
       *
  +    * If the system identifier is a URL, it must be fully resolved.
  +    *
       * @param systemId The system identifier (URI).
       * @see #setSystemId(String)
  +    * @see #setNode(Node)
  +    * @see #setInputStream
       * @see #setEncoding(String)
  +    * @see #setCharacterStream
       */
     public XSLTInputSource (String systemId)
     {
  @@ -114,11 +122,15 @@
   
   
     /**
  -    * Create a new input source with a byte stream.
  +    * Create a new input source with a byte stream -- the equivalent of creating an input source
  +    * with the zero-argument constructor and setting the new object's ByteStream property.
       *
       * @param byteStream The raw byte stream containing the document.
  +    * @see #setInputStream
       * @see #setSystemId(String)
  +    * @see #setNode(Node)
       * @see #setEncoding(String)
  +    * @see #setCharacterStream
       */
     public XSLTInputSource (InputStream byteStream)
     {
  @@ -132,7 +144,10 @@
       * <p>The character stream shall not include a byte order mark.</p>
       *
       * @param characterStream The character stream containing the document.
  +    * @see #setCharacterStream
  +    * @see #setInputStream
       * @see #setSystemId(String)
  +    * @see #setNode(Node)
       * @see #setEncoding(String)
       */
     public XSLTInputSource (Reader characterStream)
  @@ -146,7 +161,11 @@
       * with the zero-argument constructor and setting the new object's Node property.
       *
       * @param node The DOM Node containing the document.
  +    * @see #setNode(Node)
  +    * @see #setCharacterStream
  +    * @see #setInputStream
       * @see #setSystemId(String)
  +    * @see #setEncoding(String)
       */
     public XSLTInputSource (Node node)
     {
  @@ -158,9 +177,12 @@
       * Create a new XSLTInputSource source from a SAX input source.
       * This operation sets the ByteStream, CharacterStream, SystemId, PublicID, and Encoding properties.
       *
  -    * @param isource The SAX input source.
  +   * @param isource The SAX input source.
  +    * @see #setCharacterStream
  +    * @see #setInputStream
       * @see #setSystemId(String)
       * @see #setEncoding(String)
  +    * @see #setNode(Node)
       */
     public XSLTInputSource (InputSource isource)
     {
  @@ -168,16 +190,16 @@
       saxSource.setInputSource(isource);
       //saxSource.setXMLReader(isource.getCharacterStream());
       this.setEncoding(isource.getEncoding());
  -    //this.setPublicId(isource.getPublicId());
       saxSource.setSystemId(isource.getSystemId());
     }
   
     /**
       * Set the DOM Node for this input source.
       *
  -    * @param characterStream The character stream containing the
  +    * @param node The DOM node containing the
       *        XML document or XSL stylesheet.
       * @see #XSLTInputSource(Node)
  +    * @see #getCharacterStream()    * 
       * @see java.io.Reader
       */
     public void setNode (Node node)
  @@ -192,6 +214,7 @@
       *
       * @return The DOM node containing the document, or null if none was supplied.
       * @see #XSLTInputSource(Node)
  +    * @see #setNode(Node)
       */
     public Node getNode ()
     {
  @@ -321,9 +344,9 @@
       }
   
       /**
  -     * Get the byte stream that was set with setByteStream.
  +     * Get the byte stream that was set with setInputStream.
        *
  -     * @return The byte stream that was set with setByteStream, or null
  +     * @return The byte stream that was set with setInputStream, or null
        * if setByteStream or the ByteStream constructor was not called.
        */
       public InputStream getInputStream() {