OSDN Git Service

add javadoc
[dictzip-java/dictzip-java.git] / dist / javadoc / org / dict / zip / DictZipInputStream.html
diff --git a/dist/javadoc/org/dict/zip/DictZipInputStream.html b/dist/javadoc/org/dict/zip/DictZipInputStream.html
new file mode 100644 (file)
index 0000000..e85ee77
--- /dev/null
@@ -0,0 +1,444 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="ja">
+<head>
+<!-- Generated by javadoc (version 1.6.0_38) on Sun Mar 06 23:48:16 JST 2016 -->
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>DictZipInputStream</title>
+<meta name="date" content="2016-03-06">
+<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+    if (location.href.indexOf('is-external=true') == -1) {
+        parent.document.title="DictZipInputStream";
+    }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!--   -->
+</a><a href="#skip-navbar_top" title="ナビゲーションリンクをスキップ"></a><a name="navbar_top_firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../org/dict/zip/package-summary.html">パッケージ</a></li>
+<li class="navBarCell1Rev">クラス</li>
+<li><a href="class-use/DictZipInputStream.html">使用</a></li>
+<li><a href="package-tree.html">階層ツリー</a></li>
+<li><a href="../../../deprecated-list.html">非推奨 API</a></li>
+<li><a href="../../../index-files/index-1.html">索引</a></li>
+<li><a href="../../../help-doc.html">ヘルプ</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../org/dict/zip/DictZipHeader.html" title="org.dict.zip 内のクラス"><span class="strong">前のクラス</span></a></li>
+<li><a href="../../../org/dict/zip/DictZipOutputStream.html" title="org.dict.zip 内のクラス"><span class="strong">次のクラス</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?org/dict/zip/DictZipInputStream.html" target="_top">フレームあり</a></li>
+<li><a href="DictZipInputStream.html" target="_top">フレームなし</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../allclasses-noframe.html">すべてのクラス</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_top");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>概要:&nbsp;</li>
+<li>入れ子&nbsp;|&nbsp;</li>
+<li><a href="#fields_inherited_from_class_java.util.zip.InflaterInputStream">フィールド</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">コンストラクタ</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">メソッド</a></li>
+</ul>
+<ul class="subNavList">
+<li>詳細:&nbsp;</li>
+<li>フィールド&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">コンストラクタ</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">メソッド</a></li>
+</ul>
+</div>
+<a name="skip-navbar_top">
+<!--   -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<p class="subTitle">org.dict.zip</p>
+<h2 title="クラス DictZipInputStream" class="title">クラス DictZipInputStream</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>java.io.InputStream</li>
+<li>
+<ul class="inheritance">
+<li>java.io.FilterInputStream</li>
+<li>
+<ul class="inheritance">
+<li>java.util.zip.InflaterInputStream</li>
+<li>
+<ul class="inheritance">
+<li>org.dict.zip.DictZipInputStream</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>すべての実装されたインタフェース:</dt>
+<dd>java.io.Closeable</dd>
+</dl>
+<hr>
+<br>
+<pre>public class <strong>DictZipInputStream</strong>
+extends java.util.zip.InflaterInputStream</pre>
+<div class="block">DictZipInputStream.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_summary">
+<!--   -->
+</a>
+<h3>フィールドの概要</h3>
+<ul class="blockList">
+<li class="blockList"><a name="fields_inherited_from_class_java.util.zip.InflaterInputStream">
+<!--   -->
+</a>
+<h3>クラス {0} から継承されたフィールド&nbsp;java.util.zip.InflaterInputStream</h3>
+<code>buf, inf, len</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="fields_inherited_from_class_java.io.FilterInputStream">
+<!--   -->
+</a>
+<h3>クラス {0} から継承されたフィールド&nbsp;java.io.FilterInputStream</h3>
+<code>in</code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_summary">
+<!--   -->
+</a>
+<h3>コンストラクタの概要</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="コンストラクタの概要 table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and 説明</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../org/dict/zip/DictZipInputStream.html#DictZipInputStream(java.io.InputStream)">DictZipInputStream</a></strong>(java.io.InputStream&nbsp;in)</code>
+<div class="block">Creates a new input stream with a default buffer size.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../org/dict/zip/DictZipInputStream.html#DictZipInputStream(java.io.InputStream, int)">DictZipInputStream</a></strong>(java.io.InputStream&nbsp;in,
+                  int&nbsp;size)</code>
+<div class="block">Creates a new input stream with the specified buffer size.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!--   -->
+</a>
+<h3>メソッドの概要</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="メソッドの概要 table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and 説明</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../org/dict/zip/DictZipInputStream.html#close()">close</a></strong>()</code>
+<div class="block">Closes the input stream.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../org/dict/zip/DictZipInputStream.html#read(byte[], int, int)">read</a></strong>(byte[]&nbsp;buf,
+    int&nbsp;off,
+    int&nbsp;size)</code>
+<div class="block">Reads uncompressed data into an array of bytes.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../org/dict/zip/DictZipInputStream.html#readFully(byte[])">readFully</a></strong>(byte[]&nbsp;buf)</code>
+<div class="block">Read full data.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../org/dict/zip/DictZipInputStream.html#readFully(byte[], int, int)">readFully</a></strong>(byte[]&nbsp;buf,
+         int&nbsp;off,
+         int&nbsp;len)</code>
+<div class="block">Read full data by offset/length.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../org/dict/zip/DictZipHeader.html" title="org.dict.zip 内のクラス">DictZipHeader</a></code></td>
+<td class="colLast"><code><strong><a href="../../../org/dict/zip/DictZipInputStream.html#readHeader()">readHeader</a></strong>()</code>
+<div class="block">Read dictzip header.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.util.zip.InflaterInputStream">
+<!--   -->
+</a>
+<h3>クラス {0} から継承されたメソッド&nbsp;java.util.zip.InflaterInputStream</h3>
+<code>available, fill, mark, markSupported, read, reset, skip</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.io.FilterInputStream">
+<!--   -->
+</a>
+<h3>クラス {0} から継承されたメソッド&nbsp;java.io.FilterInputStream</h3>
+<code>read</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
+<!--   -->
+</a>
+<h3>クラス {0} から継承されたメソッド&nbsp;java.lang.Object</h3>
+<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_detail">
+<!--   -->
+</a>
+<h3>コンストラクタの詳細</h3>
+<a name="DictZipInputStream(java.io.InputStream)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>DictZipInputStream</h4>
+<pre>public&nbsp;DictZipInputStream(java.io.InputStream&nbsp;in)
+                   throws java.io.IOException</pre>
+<div class="block">Creates a new input stream with a default buffer size.</div>
+<dl><dt><span class="strong">パラメータ:</span></dt><dd><code>in</code> - the input stream</dd>
+<dt><span class="strong">例外:</span></dt>
+<dd><code>java.io.IOException</code> - if an I/O error has occurred</dd></dl>
+</li>
+</ul>
+<a name="DictZipInputStream(java.io.InputStream, int)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>DictZipInputStream</h4>
+<pre>public&nbsp;DictZipInputStream(java.io.InputStream&nbsp;in,
+                  int&nbsp;size)
+                   throws java.io.IOException</pre>
+<div class="block">Creates a new input stream with the specified buffer size.</div>
+<dl><dt><span class="strong">パラメータ:</span></dt><dd><code>in</code> - the input stream</dd><dd><code>size</code> - the input buffer size</dd>
+<dt><span class="strong">例外:</span></dt>
+<dd><code>java.io.IOException</code> - if an I/O error has occurred</dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!--   -->
+</a>
+<h3>メソッドの詳細</h3>
+<a name="close()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>close</h4>
+<pre>public final&nbsp;void&nbsp;close()
+                 throws java.io.IOException</pre>
+<div class="block">Closes the input stream.</div>
+<dl>
+<dt><strong>定義:</strong></dt>
+<dd><code>close</code>&nbsp;インタフェース {1} 内の {0}&nbsp;<code>java.io.Closeable</code></dd>
+<dt><strong>オーバーライド:</strong></dt>
+<dd><code>close</code>&nbsp;クラス {1} 内の {0}&nbsp;<code>java.util.zip.InflaterInputStream</code></dd>
+<dt><span class="strong">例外:</span></dt>
+<dd><code>java.io.IOException</code> - if an I/O error has occurred</dd></dl>
+</li>
+</ul>
+<a name="read(byte[], int, int)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>read</h4>
+<pre>public final&nbsp;int&nbsp;read(byte[]&nbsp;buf,
+       int&nbsp;off,
+       int&nbsp;size)
+               throws java.io.IOException</pre>
+<div class="block">Reads uncompressed data into an array of bytes. Blocks until enough input is available for
+ decompression.</div>
+<dl>
+<dt><strong>オーバーライド:</strong></dt>
+<dd><code>read</code>&nbsp;クラス {1} 内の {0}&nbsp;<code>java.util.zip.InflaterInputStream</code></dd>
+<dt><span class="strong">パラメータ:</span></dt><dd><code>buf</code> - the buffer into which the data is read</dd><dd><code>off</code> - the start offset of the data</dd><dd><code>size</code> - the maximum number of bytes read</dd>
+<dt><span class="strong">戻り値:</span></dt><dd>the actual number of bytes read, or -1 if the end of the compressed input stream is
+ reached</dd>
+<dt><span class="strong">例外:</span></dt>
+<dd><code>java.io.IOException</code> - if an I/O error has occurred or the compressed input data is corrupt</dd></dl>
+</li>
+</ul>
+<a name="readFully(byte[])">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>readFully</h4>
+<pre>public final&nbsp;void&nbsp;readFully(byte[]&nbsp;buf)
+                     throws java.io.IOException</pre>
+<div class="block">Read full data.</div>
+<dl><dt><span class="strong">パラメータ:</span></dt><dd><code>buf</code> - the buffer into which the data is read</dd>
+<dt><span class="strong">例外:</span></dt>
+<dd><code>java.io.IOException</code> - if an I/O error has occurred or the compressed input data is corrupt</dd></dl>
+</li>
+</ul>
+<a name="readFully(byte[], int, int)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>readFully</h4>
+<pre>public final&nbsp;void&nbsp;readFully(byte[]&nbsp;buf,
+             int&nbsp;off,
+             int&nbsp;len)
+                     throws java.io.IOException</pre>
+<div class="block">Read full data by offset/length.</div>
+<dl><dt><span class="strong">パラメータ:</span></dt><dd><code>buf</code> - the buffer into which the data is read</dd><dd><code>off</code> - offset</dd><dd><code>len</code> - length</dd>
+<dt><span class="strong">例外:</span></dt>
+<dd><code>java.io.IOException</code> - if an I/O error has occurred or the compressed input data is corrupt</dd></dl>
+</li>
+</ul>
+<a name="readHeader()">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>readHeader</h4>
+<pre>public final&nbsp;<a href="../../../org/dict/zip/DictZipHeader.html" title="org.dict.zip 内のクラス">DictZipHeader</a>&nbsp;readHeader()
+                               throws java.io.IOException</pre>
+<div class="block">Read dictzip header.</div>
+<dl><dt><span class="strong">戻り値:</span></dt><dd>header object.</dd>
+<dt><span class="strong">例外:</span></dt>
+<dd><code>java.io.IOException</code> - if an I/O error has occurred.</dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!--   -->
+</a><a href="#skip-navbar_bottom" title="ナビゲーションリンクをスキップ"></a><a name="navbar_bottom_firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../org/dict/zip/package-summary.html">パッケージ</a></li>
+<li class="navBarCell1Rev">クラス</li>
+<li><a href="class-use/DictZipInputStream.html">使用</a></li>
+<li><a href="package-tree.html">階層ツリー</a></li>
+<li><a href="../../../deprecated-list.html">非推奨 API</a></li>
+<li><a href="../../../index-files/index-1.html">索引</a></li>
+<li><a href="../../../help-doc.html">ヘルプ</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../org/dict/zip/DictZipHeader.html" title="org.dict.zip 内のクラス"><span class="strong">前のクラス</span></a></li>
+<li><a href="../../../org/dict/zip/DictZipOutputStream.html" title="org.dict.zip 内のクラス"><span class="strong">次のクラス</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?org/dict/zip/DictZipInputStream.html" target="_top">フレームあり</a></li>
+<li><a href="DictZipInputStream.html" target="_top">フレームなし</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../allclasses-noframe.html">すべてのクラス</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_bottom");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>概要:&nbsp;</li>
+<li>入れ子&nbsp;|&nbsp;</li>
+<li><a href="#fields_inherited_from_class_java.util.zip.InflaterInputStream">フィールド</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">コンストラクタ</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">メソッド</a></li>
+</ul>
+<ul class="subNavList">
+<li>詳細:&nbsp;</li>
+<li>フィールド&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">コンストラクタ</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">メソッド</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>