libini4j-java-doc 0.5.2-SNAPSHOT-1ubuntu1 / usr / share / doc / libini4j-java-doc / api / src-html / org / ini4j / tutorial / OptionMapTutorial.html

This file is indexed.

/usr/share/doc/libini4j-java-doc/api/src-html/org/ini4j/tutorial/OptionMapTutorial.html is in libini4j-java-doc 0.5.2-SNAPSHOT-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Copyright 2005,2009 Ivan SZKIBA<a name="line.2"></a>
<FONT color="green">003</FONT>     *<a name="line.3"></a>
<FONT color="green">004</FONT>     * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<FONT color="green">005</FONT>     * you may not use this file except in compliance with the License.<a name="line.5"></a>
<FONT color="green">006</FONT>     * You may obtain a copy of the License at<a name="line.6"></a>
<FONT color="green">007</FONT>     *<a name="line.7"></a>
<FONT color="green">008</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<FONT color="green">009</FONT>     *<a name="line.9"></a>
<FONT color="green">010</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<FONT color="green">011</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<FONT color="green">012</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<FONT color="green">013</FONT>     * See the License for the specific language governing permissions and<a name="line.13"></a>
<FONT color="green">014</FONT>     * limitations under the License.<a name="line.14"></a>
<FONT color="green">015</FONT>     */<a name="line.15"></a>
<FONT color="green">016</FONT>    package org.ini4j.tutorial;<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    import org.ini4j.Ini;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import org.ini4j.sample.Dwarfs;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    import org.ini4j.test.DwarfsData;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    import static org.junit.Assert.*;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    import java.io.File;<a name="line.26"></a>
<FONT color="green">027</FONT>    <a name="line.27"></a>
<FONT color="green">028</FONT>    import java.util.Set;<a name="line.28"></a>
<FONT color="green">029</FONT>    <a name="line.29"></a>
<FONT color="green">030</FONT>    //&lt;editor-fold defaultstate="collapsed" desc="apt documentation"&gt;<a name="line.30"></a>
<FONT color="green">031</FONT>    //|<a name="line.31"></a>
<FONT color="green">032</FONT>    //|                -------------<a name="line.32"></a>
<FONT color="green">033</FONT>    //|                OptionMap Tutorial<a name="line.33"></a>
<FONT color="green">034</FONT>    //|<a name="line.34"></a>
<FONT color="green">035</FONT>    //|OptionMap Tutorial - more than just String,String map<a name="line.35"></a>
<FONT color="green">036</FONT>    //|<a name="line.36"></a>
<FONT color="green">037</FONT>    //| Option is a name/value pair stored in OptionMap. But OptionMap adds a lot of<a name="line.37"></a>
<FONT color="green">038</FONT>    //| usefull data access methods than simple get. OptionMap is base interface for<a name="line.38"></a>
<FONT color="green">039</FONT>    //| both Ini.Section, Registry.Key and Options classes, so this tutorial will<a name="line.39"></a>
<FONT color="green">040</FONT>    //| usefull for all of these.<a name="line.40"></a>
<FONT color="green">041</FONT>    //|<a name="line.41"></a>
<FONT color="green">042</FONT>    //| So in samples bellow you can use either Ini.Section, Registry.Key or Options<a name="line.42"></a>
<FONT color="green">043</FONT>    //| classes instead of OptionMap interface, because these classes implements<a name="line.43"></a>
<FONT color="green">044</FONT>    //| OptionMap.<a name="line.44"></a>
<FONT color="green">045</FONT>    //|<a name="line.45"></a>
<FONT color="green">046</FONT>    //| Code sniplets in this tutorial tested with the following files:<a name="line.46"></a>
<FONT color="green">047</FONT>    //| {{{../sample/dwarfs.ini.html}dwarfs.ini}}<a name="line.47"></a>
<FONT color="green">048</FONT>    //| {{{../sample/dwarfs.opt.html}dwarfs.opt}}<a name="line.48"></a>
<FONT color="green">049</FONT>    //|<a name="line.49"></a>
<FONT color="green">050</FONT>    //&lt;/editor-fold&gt;<a name="line.50"></a>
<FONT color="green">051</FONT>    public class OptionMapTutorial extends AbstractTutorial<a name="line.51"></a>
<FONT color="green">052</FONT>    {<a name="line.52"></a>
<FONT color="green">053</FONT>        public static void main(String[] args) throws Exception<a name="line.53"></a>
<FONT color="green">054</FONT>        {<a name="line.54"></a>
<FONT color="green">055</FONT>            new OptionMapTutorial().run(filearg(args));<a name="line.55"></a>
<FONT color="green">056</FONT>        }<a name="line.56"></a>
<FONT color="green">057</FONT>    <a name="line.57"></a>
<FONT color="green">058</FONT>        @Override protected void run(File arg) throws Exception<a name="line.58"></a>
<FONT color="green">059</FONT>        {<a name="line.59"></a>
<FONT color="green">060</FONT>            Ini ini = new Ini(arg.toURI().toURL());<a name="line.60"></a>
<FONT color="green">061</FONT>    <a name="line.61"></a>
<FONT color="green">062</FONT>            sample01(ini.get(Dwarfs.PROP_HAPPY));<a name="line.62"></a>
<FONT color="green">063</FONT>            sample03(ini);<a name="line.63"></a>
<FONT color="green">064</FONT>            sample04(ini);<a name="line.64"></a>
<FONT color="green">065</FONT>        }<a name="line.65"></a>
<FONT color="green">066</FONT>    <a name="line.66"></a>
<FONT color="green">067</FONT>    //|* Data model<a name="line.67"></a>
<FONT color="green">068</FONT>    //|<a name="line.68"></a>
<FONT color="green">069</FONT>    //| OptionMap implements Map\&lt;String,String\&gt;, so you can access options using<a name="line.69"></a>
<FONT color="green">070</FONT>    //| standard collection api.<a name="line.70"></a>
<FONT color="green">071</FONT>    //{<a name="line.71"></a>
<FONT color="green">072</FONT>        void sample01(Ini.Section section)<a name="line.72"></a>
<FONT color="green">073</FONT>        {<a name="line.73"></a>
<FONT color="green">074</FONT>    <a name="line.74"></a>
<FONT color="green">075</FONT>            //<a name="line.75"></a>
<FONT color="green">076</FONT>            // read some values<a name="line.76"></a>
<FONT color="green">077</FONT>            //<a name="line.77"></a>
<FONT color="green">078</FONT>            String age = section.get("age");<a name="line.78"></a>
<FONT color="green">079</FONT>            String weight = section.get("weight");<a name="line.79"></a>
<FONT color="green">080</FONT>            String homeDir = section.get("homeDir");<a name="line.80"></a>
<FONT color="green">081</FONT>    <a name="line.81"></a>
<FONT color="green">082</FONT>            // get all option names<a name="line.82"></a>
<FONT color="green">083</FONT>            Set&lt;String&gt; optionNames = section.keySet();<a name="line.83"></a>
<FONT color="green">084</FONT>    <a name="line.84"></a>
<FONT color="green">085</FONT>    //}<a name="line.85"></a>
<FONT color="green">086</FONT>            assertEquals(String.valueOf(DwarfsData.happy.age), age);<a name="line.86"></a>
<FONT color="green">087</FONT>            assertEquals(String.valueOf(DwarfsData.happy.weight), weight);<a name="line.87"></a>
<FONT color="green">088</FONT>            assertEquals(String.valueOf(DwarfsData.happy.homeDir), homeDir);<a name="line.88"></a>
<FONT color="green">089</FONT>        }<a name="line.89"></a>
<FONT color="green">090</FONT>    <a name="line.90"></a>
<FONT color="green">091</FONT>    //|<a name="line.91"></a>
<FONT color="green">092</FONT>    //|* Macro/variable substitution<a name="line.92"></a>
<FONT color="green">093</FONT>    //|<a name="line.93"></a>
<FONT color="green">094</FONT>    //| To get a value, besides &lt;&lt;&lt;get()&gt;&gt;&gt; you can also<a name="line.94"></a>
<FONT color="green">095</FONT>    //| use &lt;&lt;&lt;fetch()&gt;&gt;&gt; which resolves any occurrent $\{section/option\} format<a name="line.95"></a>
<FONT color="green">096</FONT>    //| variable references in the needed value.<a name="line.96"></a>
<FONT color="green">097</FONT>    //|<a name="line.97"></a>
<FONT color="green">098</FONT>    //{<a name="line.98"></a>
<FONT color="green">099</FONT>        void sample03(Ini ini)<a name="line.99"></a>
<FONT color="green">100</FONT>        {<a name="line.100"></a>
<FONT color="green">101</FONT>            Ini.Section dopey = ini.get("dopey");<a name="line.101"></a>
<FONT color="green">102</FONT>    <a name="line.102"></a>
<FONT color="green">103</FONT>            // get method doesn't resolve variable references<a name="line.103"></a>
<FONT color="green">104</FONT>            String weightRaw = dopey.get("weight");  // = ${bashful/weight}<a name="line.104"></a>
<FONT color="green">105</FONT>            String heightRaw = dopey.get("height");  // = ${doc/height}<a name="line.105"></a>
<FONT color="green">106</FONT>    <a name="line.106"></a>
<FONT color="green">107</FONT>            // to resolve references, you should use fetch method<a name="line.107"></a>
<FONT color="green">108</FONT>            String weight = dopey.fetch("weight");  // = 45.7<a name="line.108"></a>
<FONT color="green">109</FONT>            String height = dopey.fetch("height");  // = 87.7<a name="line.109"></a>
<FONT color="green">110</FONT>    <a name="line.110"></a>
<FONT color="green">111</FONT>    //}<a name="line.111"></a>
<FONT color="green">112</FONT>    //| Assuming we have an .ini file with the following sections:<a name="line.112"></a>
<FONT color="green">113</FONT>    //|<a name="line.113"></a>
<FONT color="green">114</FONT>    //|+--------------+<a name="line.114"></a>
<FONT color="green">115</FONT>    //| [dopey]<a name="line.115"></a>
<FONT color="green">116</FONT>    //| weight = ${bashful/weight}<a name="line.116"></a>
<FONT color="green">117</FONT>    //| height = ${doc/height}<a name="line.117"></a>
<FONT color="green">118</FONT>    //|<a name="line.118"></a>
<FONT color="green">119</FONT>    //|[bashful]<a name="line.119"></a>
<FONT color="green">120</FONT>    //| weight = 45.7<a name="line.120"></a>
<FONT color="green">121</FONT>    //| height = 98.8<a name="line.121"></a>
<FONT color="green">122</FONT>    //|<a name="line.122"></a>
<FONT color="green">123</FONT>    //| [doc]<a name="line.123"></a>
<FONT color="green">124</FONT>    //| weight = 49.5<a name="line.124"></a>
<FONT color="green">125</FONT>    //| height = 87.7<a name="line.125"></a>
<FONT color="green">126</FONT>    //|+--------------+<a name="line.126"></a>
<FONT color="green">127</FONT>    //|<a name="line.127"></a>
<FONT color="green">128</FONT>            assertEquals(DwarfsData.INI_DOPEY_WEIGHT, weightRaw);<a name="line.128"></a>
<FONT color="green">129</FONT>            assertEquals(DwarfsData.INI_DOPEY_HEIGHT, heightRaw);<a name="line.129"></a>
<FONT color="green">130</FONT>            assertEquals(String.valueOf(DwarfsData.dopey.weight), weight);<a name="line.130"></a>
<FONT color="green">131</FONT>            assertEquals(String.valueOf(DwarfsData.dopey.height), height);<a name="line.131"></a>
<FONT color="green">132</FONT>        }<a name="line.132"></a>
<FONT color="green">133</FONT>    <a name="line.133"></a>
<FONT color="green">134</FONT>    //|<a name="line.134"></a>
<FONT color="green">135</FONT>    //|* Multi values<a name="line.135"></a>
<FONT color="green">136</FONT>    //|<a name="line.136"></a>
<FONT color="green">137</FONT>    //| \[ini4j\] library introduces MultiMap interface, which is extends normal<a name="line.137"></a>
<FONT color="green">138</FONT>    //| Map, but allows multiply values per keys. You can simply index values for<a name="line.138"></a>
<FONT color="green">139</FONT>    //| a given key, similar to indexed properties in JavaBeans api.<a name="line.139"></a>
<FONT color="green">140</FONT>    //|<a name="line.140"></a>
<FONT color="green">141</FONT>    //{<a name="line.141"></a>
<FONT color="green">142</FONT>        void sample04(Ini ini)<a name="line.142"></a>
<FONT color="green">143</FONT>        {<a name="line.143"></a>
<FONT color="green">144</FONT>            Ini.Section sneezy = ini.get("sneezy");<a name="line.144"></a>
<FONT color="green">145</FONT>            String n1 = sneezy.get("fortuneNumber", 0);  // = 11<a name="line.145"></a>
<FONT color="green">146</FONT>            String n2 = sneezy.get("fortuneNumber", 1);  // = 22<a name="line.146"></a>
<FONT color="green">147</FONT>            String n3 = sneezy.get("fortuneNumber", 2);  // = 33<a name="line.147"></a>
<FONT color="green">148</FONT>            String n4 = sneezy.get("fortuneNumber", 3);  // = 44<a name="line.148"></a>
<FONT color="green">149</FONT>    <a name="line.149"></a>
<FONT color="green">150</FONT>            // ok, lets do in it easier...<a name="line.150"></a>
<FONT color="green">151</FONT>            int[] n = sneezy.get("fortuneNumber", int[].class);<a name="line.151"></a>
<FONT color="green">152</FONT>    //}<a name="line.152"></a>
<FONT color="green">153</FONT>        }<a name="line.153"></a>
<FONT color="green">154</FONT>    }<a name="line.154"></a>




























































</PRE>
</BODY>
</HTML>

APT Browse - Built by Thomas Orozco.