| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class InputSource |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class InputSource |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation "> |
| <meta name="generator" content="docfx 2.56.2.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="benchmark/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Sax.InputSource"> |
| |
| |
| <h1 id="Sax_InputSource" data-uid="Sax.InputSource" class="text-break">Class InputSource |
| </h1> |
| <div class="markdown level0 summary"><p>A single input source for an XML entity.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">InputSource</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Sax.html">Sax</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Benchmark.dll</h6> |
| <h5 id="Sax_InputSource_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class InputSource</code></pre> |
| </div> |
| <h5 id="Sax_InputSource_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p><em>This module, both source code and documentation, is in the |
| Public Domain, and comes with<strong> NO WARRANTY</strong>.</em> |
| See<a href="http://www.saxproject.org">http://www.saxproject.org</a> |
| for further information. |
| <p> |
| This class allows a SAX application to encapsulate information |
| about an input source in a single object, which may include |
| a public identifier, a system identifier, a byte stream (possibly |
| with a specified encoding), and/or a character stream. |
| <p> |
| There are two places that the application can deliver an |
| input source to the parser: as the argument to the IParser.Parse(InputSource) |
| method, or as the return value of the <a class="xref" href="Sax.IEntityResolver.html#Sax_IEntityResolver_ResolveEntity_System_String_System_String_">ResolveEntity(String, String)</a> |
| method. |
| <p> |
| The SAX parser will use the InputSource object to determine how |
| to read XML input. If there is a character stream available, the |
| parser will read that stream directly, disregarding any text |
| encoding declaration found in that stream. |
| If there is no character stream, but there is |
| a byte stream, the parser will use that byte stream, using the |
| encoding specified in the <a class="xref" href="Sax.InputSource.html">InputSource</a> or else (if no encoding is |
| specified) autodetecting the character encoding using an algorithm |
| such as the one in the XML specification. If neither a character |
| stream nor a |
| byte stream is available, the parser will attempt to open a URL |
| connection to the resource identified by the system |
| identifier. |
| <p> |
| An <a class="xref" href="Sax.InputSource.html">InputSource</a> object belongs to the application: the SAX parser |
| shall never modify it in any way (it may modify a copy if |
| necessary). However, standard processing of both byte and |
| character streams is to close them on as part of end-of-parse cleanup, |
| so applications should not attempt to re-use such streams after they |
| have been handed to a parser.</p> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Sax_InputSource__ctor.md&value=---%0Auid%3A%20Sax.InputSource.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Benchmark/Support/Sax/InputSource.cs/#L68">View Source</a> |
| </span> |
| <a id="Sax_InputSource__ctor_" data-uid="Sax.InputSource.#ctor*"></a> |
| <h4 id="Sax_InputSource__ctor" data-uid="Sax.InputSource.#ctor">InputSource()</h4> |
| <div class="markdown level1 summary"><p>Zero-argument default constructor.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public InputSource()</code></pre> |
| </div> |
| <h5 id="Sax_InputSource__ctor_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_PublicId">PublicId</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_SystemId">SystemId</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_Stream">Stream</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_TextReader">TextReader</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_Encoding">Encoding</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Sax_InputSource__ctor_System_IO_Stream_.md&value=---%0Auid%3A%20Sax.InputSource.%23ctor(System.IO.Stream)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Benchmark/Support/Sax/InputSource.cs/#L109">View Source</a> |
| </span> |
| <a id="Sax_InputSource__ctor_" data-uid="Sax.InputSource.#ctor*"></a> |
| <h4 id="Sax_InputSource__ctor_System_IO_Stream_" data-uid="Sax.InputSource.#ctor(System.IO.Stream)">InputSource(Stream)</h4> |
| <div class="markdown level1 summary"><p>Create a new input source with a byte stream.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public InputSource(Stream byteStream)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.Stream</span></td> |
| <td><span class="parametername">byteStream</span></td> |
| <td><p>The raw byte stream containing the document.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_InputSource__ctor_System_IO_Stream__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Application writers should use <a class="xref" href="Sax.InputSource.html#Sax_InputSource_SystemId">SystemId</a> to provide a base |
| for resolving relative URIs, may use <a class="xref" href="Sax.InputSource.html#Sax_InputSource_PublicId">PublicId</a> to include a |
| public identifier, and may use <a class="xref" href="Sax.InputSource.html#Sax_InputSource_Encoding">Encoding</a> to specify the object's |
| character encoding.</p> |
| </div> |
| <h5 id="Sax_InputSource__ctor_System_IO_Stream__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_PublicId">PublicId</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_SystemId">SystemId</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_Encoding">Encoding</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_Stream">Stream</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_TextReader">TextReader</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Sax_InputSource__ctor_System_IO_TextReader_.md&value=---%0Auid%3A%20Sax.InputSource.%23ctor(System.IO.TextReader)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Benchmark/Support/Sax/InputSource.cs/#L129">View Source</a> |
| </span> |
| <a id="Sax_InputSource__ctor_" data-uid="Sax.InputSource.#ctor*"></a> |
| <h4 id="Sax_InputSource__ctor_System_IO_TextReader_" data-uid="Sax.InputSource.#ctor(System.IO.TextReader)">InputSource(TextReader)</h4> |
| <div class="markdown level1 summary"><p>Create a new input source with a character stream.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public InputSource(TextReader characterStream)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.TextReader</span></td> |
| <td><span class="parametername">characterStream</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_InputSource__ctor_System_IO_TextReader__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Application writers should use <a class="xref" href="Sax.InputSource.html#Sax_InputSource_SystemId">SystemId</a> to provide a base |
| for resolving relative URIs, and may use <a class="xref" href="Sax.InputSource.html#Sax_InputSource_PublicId">PublicId</a> to include a |
| public identifier. |
| <p> |
| The character stream shall not include a byte order mark.</p> |
| </div> |
| <h5 id="Sax_InputSource__ctor_System_IO_TextReader__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_PublicId">PublicId</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_SystemId">SystemId</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_Stream">Stream</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_TextReader">TextReader</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Sax_InputSource__ctor_System_String_.md&value=---%0Auid%3A%20Sax.InputSource.%23ctor(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Benchmark/Support/Sax/InputSource.cs/#L89">View Source</a> |
| </span> |
| <a id="Sax_InputSource__ctor_" data-uid="Sax.InputSource.#ctor*"></a> |
| <h4 id="Sax_InputSource__ctor_System_String_" data-uid="Sax.InputSource.#ctor(System.String)">InputSource(String)</h4> |
| <div class="markdown level1 summary"><p>Create a new input source with a system identifier.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public InputSource(string systemId)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">systemId</span></td> |
| <td><p>The system identifier (URI).</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_InputSource__ctor_System_String__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Applications may use <a class="xref" href="Sax.InputSource.html#Sax_InputSource_PublicId">PublicId</a> to include a |
| public identifier as well, or <a class="xref" href="Sax.InputSource.html#Sax_InputSource_Encoding">Encoding</a> to specify |
| the character encoding, if known. |
| <p> |
| If the system identifier is a URL, it must be fully |
| resolved (it may not be a relative URL).</p> |
| </div> |
| <h5 id="Sax_InputSource__ctor_System_String__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_PublicId">PublicId</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_SystemId">SystemId</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_Stream">Stream</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_TextReader">TextReader</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_Encoding">Encoding</a></div> |
| </div> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Sax_InputSource_Encoding.md&value=---%0Auid%3A%20Sax.InputSource.Encoding%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Benchmark/Support/Sax/InputSource.cs/#L211">View Source</a> |
| </span> |
| <a id="Sax_InputSource_Encoding_" data-uid="Sax.InputSource.Encoding*"></a> |
| <h4 id="Sax_InputSource_Encoding" data-uid="Sax.InputSource.Encoding">Encoding</h4> |
| <div class="markdown level1 summary"><p>Gets or Sets the character encoding.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Encoding Encoding { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Text.Encoding</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_InputSource_Encoding_remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>The encoding must be a string acceptable for an |
| XML encoding declaration(see section 4.3.3 of the XML 1.0 |
| recommendation). |
| <p> |
| This method has no effect when the application provides a |
| character stream.</p> |
| </div> |
| <h5 id="Sax_InputSource_Encoding_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_SystemId">SystemId</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_Stream">Stream</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Sax_InputSource_PublicId.md&value=---%0Auid%3A%20Sax.InputSource.PublicId%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Benchmark/Support/Sax/InputSource.cs/#L144">View Source</a> |
| </span> |
| <a id="Sax_InputSource_PublicId_" data-uid="Sax.InputSource.PublicId*"></a> |
| <h4 id="Sax_InputSource_PublicId" data-uid="Sax.InputSource.PublicId">PublicId</h4> |
| <div class="markdown level1 summary"><p>Gets or Sets the public identifier for this input source.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string PublicId { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_InputSource_PublicId_remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>The public identifier is always optional: if the application |
| writer includes one, it will be provided as part of the |
| location information.</p> |
| </div> |
| <h5 id="Sax_InputSource_PublicId_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.ILocator.html#Sax_ILocator_PublicId">PublicId</a></div> |
| <div><a class="xref" href="Sax.SAXParseException.html#Sax_SAXParseException_PublicId">PublicId</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Sax_InputSource_Stream.md&value=---%0Auid%3A%20Sax.InputSource.Stream%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Benchmark/Support/Sax/InputSource.cs/#L192">View Source</a> |
| </span> |
| <a id="Sax_InputSource_Stream_" data-uid="Sax.InputSource.Stream*"></a> |
| <h4 id="Sax_InputSource_Stream" data-uid="Sax.InputSource.Stream">Stream</h4> |
| <div class="markdown level1 summary"><p>Gets or Sets the byte stream for this input source.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Stream Stream { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.Stream</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_InputSource_Stream_remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>The SAX parser will ignore this if there is also a character |
| stream specified, but it will use a byte stream in preference |
| to opening a URI connection itself. |
| <p> |
| If the application knows the character encoding of the |
| byte stream, it should set it with the setEncoding method.</p> |
| </div> |
| <h5 id="Sax_InputSource_Stream_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_Encoding">Encoding</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_Stream">Stream</a></div> |
| <div><span class="xref">System.IO.Stream</span></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Sax_InputSource_SystemId.md&value=---%0Auid%3A%20Sax.InputSource.SystemId%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Benchmark/Support/Sax/InputSource.cs/#L172">View Source</a> |
| </span> |
| <a id="Sax_InputSource_SystemId_" data-uid="Sax.InputSource.SystemId*"></a> |
| <h4 id="Sax_InputSource_SystemId" data-uid="Sax.InputSource.SystemId">SystemId</h4> |
| <div class="markdown level1 summary"><p>Gets or Sets the system identifier for this input source.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string SystemId { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_InputSource_SystemId_remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>The system identifier is optional if there is a byte stream |
| or a character stream, but it is still useful to provide one, |
| since the application can use it to resolve relative URIs |
| and can include it in error messages and warnings(the parser |
| will attempt to open a connection to the URI only if |
| there is no byte stream or character stream specified). |
| <p> |
| If the application knows the character encoding of the |
| object pointed to by the system identifier, it can register |
| the encoding using the <a class="xref" href="Sax.InputSource.html#Sax_InputSource_Encoding">Encoding</a> property setter. |
| <p> |
| If the system identifier is a URL, it must be fully |
| resolved(it may not be a relative URL).</p> |
| </div> |
| <h5 id="Sax_InputSource_SystemId_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_Encoding">Encoding</a></div> |
| <div><a class="xref" href="Sax.InputSource.html#Sax_InputSource_SystemId">SystemId</a></div> |
| <div><a class="xref" href="Sax.ILocator.html#Sax_ILocator_SystemId">SystemId</a></div> |
| <div><a class="xref" href="Sax.SAXParseException.html#Sax_SAXParseException_SystemId">SystemId</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Sax_InputSource_TextReader.md&value=---%0Auid%3A%20Sax.InputSource.TextReader%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Benchmark/Support/Sax/InputSource.cs/#L226">View Source</a> |
| </span> |
| <a id="Sax_InputSource_TextReader_" data-uid="Sax.InputSource.TextReader*"></a> |
| <h4 id="Sax_InputSource_TextReader" data-uid="Sax.InputSource.TextReader">TextReader</h4> |
| <div class="markdown level1 summary"><p>Gets or Sets the character stream for this input source.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual TextReader TextReader { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.TextReader</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_InputSource_TextReader_remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>If there is a character stream specified, the SAX parser |
| will ignore any byte stream and will not attempt to open |
| a URI connection to the system identifier.</p> |
| </div> |
| <h5 id="Sax_InputSource_TextReader_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><span class="xref">System.IO.TextReader</span></div> |
| </div> |
| <h3 id="seealso">See Also</h3> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.IXMLReader.html#Sax_IXMLReader_Parse_Sax_InputSource_">Parse</a>(<a class="xref" href="Sax.InputSource.html">InputSource</a>)</div> |
| <div><a class="xref" href="Sax.IEntityResolver.html#Sax_IEntityResolver_ResolveEntity_System_String_System_String_">ResolveEntity</a>(<span class="xref">System.String</span>, <span class="xref">System.String</span>)</div> |
| <div><span class="xref">System.IO.Stream</span></div> |
| <div><span class="xref">System.IO.TextReader</span></div> |
| </div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Sax_InputSource.md&value=---%0Auid%3A%20Sax.InputSource%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Benchmark/Support/Sax/InputSource.cs/#L58" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small> |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
