src/javax/xml/transform/SourceLocator.java

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


  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  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;
  27 
  28 /**
  29  * This interface is primarily for the purposes of reporting where
  30  * an error occurred in the XML source or transformation instructions.


  31  */
  32 public interface SourceLocator {
  33 
  34     /**
  35      * Return the public identifier for the current document event.
  36      *
  37      * <p>The return value is the public identifier of the document
  38      * entity or of the external parsed entity in which the markup that
  39      * triggered the event appears.</p>
  40      *
  41      * @return A string containing the public identifier, or
  42      *         null if none is available.
  43      * @see #getSystemId
  44      */
  45     public String getPublicId();
  46 
  47     /**
  48      * Return the system identifier for the current document event.
  49      *
  50      * <p>The return value is the system identifier of the document




  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  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;
  27 
  28 /**
  29  * This interface is primarily for the purposes of reporting where
  30  * an error occurred in the XML source or transformation instructions.
  31  *
  32  * @since 1.4
  33  */
  34 public interface SourceLocator {
  35 
  36     /**
  37      * Return the public identifier for the current document event.
  38      *
  39      * <p>The return value is the public identifier of the document
  40      * entity or of the external parsed entity in which the markup that
  41      * triggered the event appears.</p>
  42      *
  43      * @return A string containing the public identifier, or
  44      *         null if none is available.
  45      * @see #getSystemId
  46      */
  47     public String getPublicId();
  48 
  49     /**
  50      * Return the system identifier for the current document event.
  51      *
  52      * <p>The return value is the system identifier of the document