jaxp/src/share/classes/javax/xml/transform/Source.java
author duke
Sat, 01 Dec 2007 00:00:00 +0000
changeset 6 7f561c08de6b
permissions -rw-r--r--
Initial load
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6
7f561c08de6b Initial load
duke
parents:
diff changeset
     1
/*
7f561c08de6b Initial load
duke
parents:
diff changeset
     2
 * Copyright 2000-2005 Sun Microsystems, Inc.  All Rights Reserved.
7f561c08de6b Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7f561c08de6b Initial load
duke
parents:
diff changeset
     4
 *
7f561c08de6b Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
7f561c08de6b Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
7f561c08de6b Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
7f561c08de6b Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
7f561c08de6b Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
7f561c08de6b Initial load
duke
parents:
diff changeset
    10
 *
7f561c08de6b Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
7f561c08de6b Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
7f561c08de6b Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
7f561c08de6b Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
7f561c08de6b Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
7f561c08de6b Initial load
duke
parents:
diff changeset
    16
 *
7f561c08de6b Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
7f561c08de6b Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
7f561c08de6b Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
7f561c08de6b Initial load
duke
parents:
diff changeset
    20
 *
7f561c08de6b Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
7f561c08de6b Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
7f561c08de6b Initial load
duke
parents:
diff changeset
    23
 * have any questions.
7f561c08de6b Initial load
duke
parents:
diff changeset
    24
 */
7f561c08de6b Initial load
duke
parents:
diff changeset
    25
7f561c08de6b Initial load
duke
parents:
diff changeset
    26
package javax.xml.transform;
7f561c08de6b Initial load
duke
parents:
diff changeset
    27
7f561c08de6b Initial load
duke
parents:
diff changeset
    28
/**
7f561c08de6b Initial load
duke
parents:
diff changeset
    29
 * An object that implements this interface contains the information
7f561c08de6b Initial load
duke
parents:
diff changeset
    30
 * needed to act as source input (XML source or transformation instructions).
7f561c08de6b Initial load
duke
parents:
diff changeset
    31
 */
7f561c08de6b Initial load
duke
parents:
diff changeset
    32
public interface Source {
7f561c08de6b Initial load
duke
parents:
diff changeset
    33
7f561c08de6b Initial load
duke
parents:
diff changeset
    34
    /**
7f561c08de6b Initial load
duke
parents:
diff changeset
    35
     * Set the system identifier for this Source.
7f561c08de6b Initial load
duke
parents:
diff changeset
    36
     *
7f561c08de6b Initial load
duke
parents:
diff changeset
    37
     * <p>The system identifier is optional if the source does not
7f561c08de6b Initial load
duke
parents:
diff changeset
    38
     * get its data from a URL, but it may still be useful to provide one.
7f561c08de6b Initial load
duke
parents:
diff changeset
    39
     * The application can use a system identifier, for example, to resolve
7f561c08de6b Initial load
duke
parents:
diff changeset
    40
     * relative URIs and to include in error messages and warnings.</p>
7f561c08de6b Initial load
duke
parents:
diff changeset
    41
     *
7f561c08de6b Initial load
duke
parents:
diff changeset
    42
     * @param systemId The system identifier as a URL string.
7f561c08de6b Initial load
duke
parents:
diff changeset
    43
     */
7f561c08de6b Initial load
duke
parents:
diff changeset
    44
    public void setSystemId(String systemId);
7f561c08de6b Initial load
duke
parents:
diff changeset
    45
7f561c08de6b Initial load
duke
parents:
diff changeset
    46
    /**
7f561c08de6b Initial load
duke
parents:
diff changeset
    47
     * Get the system identifier that was set with setSystemId.
7f561c08de6b Initial load
duke
parents:
diff changeset
    48
     *
7f561c08de6b Initial load
duke
parents:
diff changeset
    49
     * @return The system identifier that was set with setSystemId, or null
7f561c08de6b Initial load
duke
parents:
diff changeset
    50
     * if setSystemId was not called.
7f561c08de6b Initial load
duke
parents:
diff changeset
    51
     */
7f561c08de6b Initial load
duke
parents:
diff changeset
    52
    public String getSystemId();
7f561c08de6b Initial load
duke
parents:
diff changeset
    53
}