| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class DictionaryExtensions |
| | Apache Lucene.NET 4.8.0 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class DictionaryExtensions |
| | Apache Lucene.NET 4.8.0 Documentation "> |
| <meta name="generator" content="docfx 2.47.0.0"> |
| |
| <link rel="shortcut icon" href="../../logo/favicon.ico"> |
| <link rel="stylesheet" href="../../styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="../../styles/docfx.css"> |
| <link rel="stylesheet" href="../../styles/main.css"> |
| <meta property="docfx:navrel" content="../../toc.html"> |
| <meta property="docfx:tocrel" content="../toc.html"> |
| |
| <meta property="docfx:rel" content="../../"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <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="../../index.html"> |
| <img id="logo" class="svg" src="../../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" id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></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="Lucene.Net.Support.DictionaryExtensions"> |
| |
| |
| <h1 id="Lucene_Net_Support_DictionaryExtensions" data-uid="Lucene.Net.Support.DictionaryExtensions" class="text-break">Class DictionaryExtensions |
| </h1> |
| <div class="markdown level0 summary"></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">DictionaryExtensions</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="../Lucene.Net.Benchmarks/Lucene.Net.Support.html">Lucene.Net.Support</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Support_DictionaryExtensions_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static class DictionaryExtensions</code></pre> |
| </div> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_DictionaryExtensions_Load_System_Collections_Generic_IDictionary_System_String_System_String__System_IO_Stream_.md&value=---%0Auid%3A%20Lucene.Net.Support.DictionaryExtensions.Load(System.Collections.Generic.IDictionary%7BSystem.String%2CSystem.String%7D%2CSystem.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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/DictionaryExtensions.cs/#L85">View Source</a> |
| </span> |
| <a id="Lucene_Net_Support_DictionaryExtensions_Load_" data-uid="Lucene.Net.Support.DictionaryExtensions.Load*"></a> |
| <h4 id="Lucene_Net_Support_DictionaryExtensions_Load_System_Collections_Generic_IDictionary_System_String_System_String__System_IO_Stream_" data-uid="Lucene.Net.Support.DictionaryExtensions.Load(System.Collections.Generic.IDictionary{System.String,System.String},System.IO.Stream)">Load(IDictionary<String, String>, Stream)</h4> |
| <div class="markdown level1 summary"><p>Loads properties from the specified <span class="xref">System.IO.Stream</span>. The encoding is |
| ISO8859-1. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void Load(this IDictionary<string, string> dict, Stream input)</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.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <span class="xref">System.String</span>></td> |
| <td><span class="parametername">dict</span></td> |
| <td><p>This dictionary.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.IO.Stream</span></td> |
| <td><span class="parametername">input</span></td> |
| <td><p>The <span class="xref">System.IO.Stream</span>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Support_DictionaryExtensions_Load_System_Collections_Generic_IDictionary_System_String_System_String__System_IO_Stream__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>The Properties file is interpreted according to the |
| following rules: |
| <ul><li> |
| Empty lines are ignored. |
| </li><li> |
| Lines starting with either a "#" or a "!" are comment lines and are |
| ignored. |
| </li><li> |
| A backslash at the end of the line escapes the following newline |
| character ("\r", "\n", "\r\n"). If there's a whitespace after the |
| backslash it will just escape that whitespace instead of concatenating |
| the lines. This does not apply to comment lines. |
| </li><li> |
| A property line consists of the key, the space between the key and |
| the value, and the value. The key goes up to the first whitespace, "=" or |
| ":" that is not escaped. The space between the key and the value contains |
| either one whitespace, one "=" or one ":" and any number of additional |
| whitespaces before and after that character. The value starts with the |
| first character after the space between the key and the value. |
| </li><li> |
| Following escape sequences are recognized: "\ ", "\", "\r", "\n", |
| "!", "#", "\t", "\b", "\f", and "\uXXXX" (unicode character). |
| </li></ul> |
| <p> |
| This method is to mimic and interoperate with the Properties class in Java, which |
| is essentially a string dictionary that natively supports importing and exporting to this format.</p> |
| </div> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If error occurs during reading from the <span class="xref">System.IO.Stream</span>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_DictionaryExtensions_Put__2_System_Collections_Generic_IDictionary___0___1____0___1_.md&value=---%0Auid%3A%20Lucene.Net.Support.DictionaryExtensions.Put%60%602(System.Collections.Generic.IDictionary%7B%60%600%2C%60%601%7D%2C%60%600%2C%60%601)%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/DictionaryExtensions.cs/#L34">View Source</a> |
| </span> |
| <a id="Lucene_Net_Support_DictionaryExtensions_Put_" data-uid="Lucene.Net.Support.DictionaryExtensions.Put*"></a> |
| <h4 id="Lucene_Net_Support_DictionaryExtensions_Put__2_System_Collections_Generic_IDictionary___0___1____0___1_" data-uid="Lucene.Net.Support.DictionaryExtensions.Put``2(System.Collections.Generic.IDictionary{``0,``1},``0,``1)">Put<TKey, TValue>(IDictionary<TKey, TValue>, TKey, TValue)</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static TValue Put<TKey, TValue>(this IDictionary<TKey, TValue> dict, TKey key, TValue value)</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.Collections.Generic.IDictionary</span><TKey, TValue></td> |
| <td><span class="parametername">dict</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">TKey</span></td> |
| <td><span class="parametername">key</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">TValue</span></td> |
| <td><span class="parametername">value</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</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">TValue</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">TKey</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="parametername">TValue</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_DictionaryExtensions_PutAll__2_System_Collections_Generic_IDictionary___0___1__System_Collections_Generic_IEnumerable_System_Collections_Generic_KeyValuePair___0___1___.md&value=---%0Auid%3A%20Lucene.Net.Support.DictionaryExtensions.PutAll%60%602(System.Collections.Generic.IDictionary%7B%60%600%2C%60%601%7D%2CSystem.Collections.Generic.IEnumerable%7BSystem.Collections.Generic.KeyValuePair%7B%60%600%2C%60%601%7D%7D)%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/DictionaryExtensions.cs/#L26">View Source</a> |
| </span> |
| <a id="Lucene_Net_Support_DictionaryExtensions_PutAll_" data-uid="Lucene.Net.Support.DictionaryExtensions.PutAll*"></a> |
| <h4 id="Lucene_Net_Support_DictionaryExtensions_PutAll__2_System_Collections_Generic_IDictionary___0___1__System_Collections_Generic_IEnumerable_System_Collections_Generic_KeyValuePair___0___1___" data-uid="Lucene.Net.Support.DictionaryExtensions.PutAll``2(System.Collections.Generic.IDictionary{``0,``1},System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{``0,``1}})">PutAll<TKey, TValue>(IDictionary<TKey, TValue>, IEnumerable<KeyValuePair<TKey, TValue>>)</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void PutAll<TKey, TValue>(this IDictionary<TKey, TValue> dict, IEnumerable<KeyValuePair<TKey, TValue>> kvps)</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.Collections.Generic.IDictionary</span><TKey, TValue></td> |
| <td><span class="parametername">dict</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">System.Collections.Generic.KeyValuePair</span><TKey, TValue>></td> |
| <td><span class="parametername">kvps</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">TKey</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="parametername">TValue</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_DictionaryExtensions_Store_System_Collections_Generic_IDictionary_System_String_System_String__System_IO_Stream_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Support.DictionaryExtensions.Store(System.Collections.Generic.IDictionary%7BSystem.String%2CSystem.String%7D%2CSystem.IO.Stream%2CSystem.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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/DictionaryExtensions.cs/#L101">View Source</a> |
| </span> |
| <a id="Lucene_Net_Support_DictionaryExtensions_Store_" data-uid="Lucene.Net.Support.DictionaryExtensions.Store*"></a> |
| <h4 id="Lucene_Net_Support_DictionaryExtensions_Store_System_Collections_Generic_IDictionary_System_String_System_String__System_IO_Stream_System_String_" data-uid="Lucene.Net.Support.DictionaryExtensions.Store(System.Collections.Generic.IDictionary{System.String,System.String},System.IO.Stream,System.String)">Store(IDictionary<String, String>, Stream, String)</h4> |
| <div class="markdown level1 summary"><p>Stores the mappings in this Properties to the specified |
| <span class="xref">System.IO.Stream</span>, putting the specified comment at the beginning. The |
| output from this method is suitable for being read by the |
| <a class="xref" href="Lucene.Net.Support.DictionaryExtensions.html#Lucene_Net_Support_DictionaryExtensions_Load_System_Collections_Generic_IDictionary_System_String_System_String__System_IO_Stream_">Load(IDictionary<String, String>, Stream)</a> method.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void Store(this IDictionary<string, string> dict, Stream output, string comments)</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.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <span class="xref">System.String</span>></td> |
| <td><span class="parametername">dict</span></td> |
| <td><p>This dictionary.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.IO.Stream</span></td> |
| <td><span class="parametername">output</span></td> |
| <td><p>The output <span class="xref">System.IO.Stream</span> to write to.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">comments</span></td> |
| <td><p>The comments to put at the beginning.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If an error occurs during the write to the <span class="xref">System.IO.Stream</span>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.InvalidCastException</span></td> |
| <td><p>If the key or value of a mapping is not a <span class="xref">System.String</span>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_DictionaryExtensions.md&value=---%0Auid%3A%20Lucene.Net.Support.DictionaryExtensions%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/DictionaryExtensions.cs/#L24" 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 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="../../styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="../../styles/docfx.js"></script> |
| <script type="text/javascript" src="../../styles/main.js"></script> |
| </body> |
| </html> |
