All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.xerces.xni.parser.XMLInputSource Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.xerces.xni.parser;

import java.io.InputStream;
import java.io.Reader;

import org.apache.xerces.xni.XMLResourceIdentifier;

/**
 * This class represents an input source for an XML document. The
 * basic properties of an input source are the following:
 * 
    *
  • public identifier
  • *
  • system identifier
  • *
  • byte stream or character stream
  • *
  • *
* * @author Andy Clark, IBM * * @version $Id: XMLInputSource.java 699892 2008-09-28 21:08:27Z mrglavas $ */ public class XMLInputSource { // // Data // /** Public identifier. */ protected String fPublicId; /** System identifier. */ protected String fSystemId; /** Base system identifier. */ protected String fBaseSystemId; /** Byte stream. */ protected InputStream fByteStream; /** Character stream. */ protected Reader fCharStream; /** Encoding. */ protected String fEncoding; // // Constructors // /** * Constructs an input source from just the public and system * identifiers, leaving resolution of the entity and opening of * the input stream up to the caller. * * @param publicId The public identifier, if known. * @param systemId The system identifier. This value should * always be set, if possible, and can be * relative or absolute. If the system identifier * is relative, then the base system identifier * should be set. * @param baseSystemId The base system identifier. This value should * always be set to the fully expanded URI of the * base system identifier, if possible. */ public XMLInputSource(String publicId, String systemId, String baseSystemId) { fPublicId = publicId; fSystemId = systemId; fBaseSystemId = baseSystemId; } // (String,String,String) /** * Constructs an input source from a XMLResourceIdentifier * object, leaving resolution of the entity and opening of * the input stream up to the caller. * * @param resourceIdentifier the XMLResourceIdentifier containing the information */ public XMLInputSource(XMLResourceIdentifier resourceIdentifier) { fPublicId = resourceIdentifier.getPublicId(); fSystemId = resourceIdentifier.getLiteralSystemId(); fBaseSystemId = resourceIdentifier.getBaseSystemId(); } // (XMLResourceIdentifier) /** * Constructs an input source from a byte stream. * * @param publicId The public identifier, if known. * @param systemId The system identifier. This value should * always be set, if possible, and can be * relative or absolute. If the system identifier * is relative, then the base system identifier * should be set. * @param baseSystemId The base system identifier. This value should * always be set to the fully expanded URI of the * base system identifier, if possible. * @param byteStream The byte stream. * @param encoding The encoding of the byte stream, if known. */ public XMLInputSource(String publicId, String systemId, String baseSystemId, InputStream byteStream, String encoding) { fPublicId = publicId; fSystemId = systemId; fBaseSystemId = baseSystemId; fByteStream = byteStream; fEncoding = encoding; } // (String,String,String,InputStream,String) /** * Constructs an input source from a character stream. * * @param publicId The public identifier, if known. * @param systemId The system identifier. This value should * always be set, if possible, and can be * relative or absolute. If the system identifier * is relative, then the base system identifier * should be set. * @param baseSystemId The base system identifier. This value should * always be set to the fully expanded URI of the * base system identifier, if possible. * @param charStream The character stream. * @param encoding The original encoding of the byte stream * used by the reader, if known. */ public XMLInputSource(String publicId, String systemId, String baseSystemId, Reader charStream, String encoding) { fPublicId = publicId; fSystemId = systemId; fBaseSystemId = baseSystemId; fCharStream = charStream; fEncoding = encoding; } // (String,String,String,Reader,String) // // Public methods // /** * Sets the public identifier. * * @param publicId The new public identifier. */ public void setPublicId(String publicId) { fPublicId = publicId; } // setPublicId(String) /** Returns the public identifier. */ public String getPublicId() { return fPublicId; } // getPublicId():String /** * Sets the system identifier. * * @param systemId The new system identifier. */ public void setSystemId(String systemId) { fSystemId = systemId; } // setSystemId(String) /** Returns the system identifier. */ public String getSystemId() { return fSystemId; } // getSystemId():String /** * Sets the base system identifier. * * @param baseSystemId The new base system identifier. */ public void setBaseSystemId(String baseSystemId) { fBaseSystemId = baseSystemId; } // setBaseSystemId(String) /** Returns the base system identifier. */ public String getBaseSystemId() { return fBaseSystemId; } // getBaseSystemId():String /** * Sets the byte stream. If the byte stream is not already opened * when this object is instantiated, then the code that opens the * stream should also set the byte stream on this object. Also, if * the encoding is auto-detected, then the encoding should also be * set on this object. * * @param byteStream The new byte stream. */ public void setByteStream(InputStream byteStream) { fByteStream = byteStream; } // setByteStream(InputSource) /** Returns the byte stream. */ public InputStream getByteStream() { return fByteStream; } // getByteStream():InputStream /** * Sets the character stream. If the character stream is not already * opened when this object is instantiated, then the code that opens * the stream should also set the character stream on this object. * Also, the encoding of the byte stream used by the reader should * also be set on this object, if known. * * @param charStream The new character stream. * * @see #setEncoding */ public void setCharacterStream(Reader charStream) { fCharStream = charStream; } // setCharacterStream(Reader) /** Returns the character stream. */ public Reader getCharacterStream() { return fCharStream; } // getCharacterStream():Reader /** * Sets the encoding of the stream. * * @param encoding The new encoding. */ public void setEncoding(String encoding) { fEncoding = encoding; } // setEncoding(String) /** Returns the encoding of the stream, or null if not known. */ public String getEncoding() { return fEncoding; } // getEncoding():String } // class XMLInputSource




© 2015 - 2024 Weber Informatics LLC | Privacy Policy