View Javadoc
1   /*
2    * Copyright (c) 2000, 2005, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
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   * An object that implements this interface contains the information
30   * needed to act as source input (XML source or transformation instructions).
31   */
32  public interface Source {
33  
34      /**
35       * Set the system identifier for this Source.
36       *
37       * <p>The system identifier is optional if the source does not
38       * get its data from a URL, but it may still be useful to provide one.
39       * The application can use a system identifier, for example, to resolve
40       * relative URIs and to include in error messages and warnings.</p>
41       *
42       * @param systemId The system identifier as a URL string.
43       */
44      public void setSystemId(String systemId);
45  
46      /**
47       * Get the system identifier that was set with setSystemId.
48       *
49       * @return The system identifier that was set with setSystemId, or null
50       * if setSystemId was not called.
51       */
52      public String getSystemId();
53  }