| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TextFile (Apache JMeter dist API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.jorphan.io, class: TextFile"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache JMeter</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.jorphan.io</a></div> |
| <h1 title="Class TextFile" class="title">Class TextFile</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">java.io.File</a> |
| <div class="inheritance">org.apache.jorphan.io.TextFile</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TextFile</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></span></div> |
| <div class="block">Utility class to handle text files as a single lump of text. |
| <p> |
| Note this is just as memory-inefficient as handling a text file can be. Use |
| with restraint.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../serialized-form.html#org.apache.jorphan.io.TextFile">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-java.io.File">Fields inherited from class java.io.<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#pathSeparator" title="class or interface in java.io" class="external-link">pathSeparator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#pathSeparatorChar" title="class or interface in java.io" class="external-link">pathSeparatorChar</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#separator" title="class or interface in java.io" class="external-link">separator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#separatorChar" title="class or interface in java.io" class="external-link">separatorChar</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.io.File)" class="member-name-link">TextFile</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> filename)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Create a TextFile object to handle the named file with the platform |
| default encoding.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.io.File,java.lang.String)" class="member-name-link">TextFile</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> filename, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> encoding)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Create a TextFile object to handle the named file with the given |
| encoding.</div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">TextFile</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> filename)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Create a TextFile object to handle the named file with the platform |
| default encoding.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String)" class="member-name-link">TextFile</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> filename, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> encoding)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Create a TextFile object to handle the named file with the given |
| encoding.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEncoding()" class="member-name-link">getEncoding</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns encoding being used to read and write this file.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getText()" class="member-name-link">getText</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Read the whole file content and return it as a string.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEncoding(java.lang.String)" class="member-name-link">setEncoding</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configures encoding to be used to read and write this file.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setText(java.lang.String)" class="member-name-link">setText</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> body)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create the file with the given string as content -- or replace its |
| content with the given string if the file already existed.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.io.File">Methods inherited from class java.io.<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#canExecute--" title="class or interface in java.io" class="external-link">canExecute</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#canRead--" title="class or interface in java.io" class="external-link">canRead</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#canWrite--" title="class or interface in java.io" class="external-link">canWrite</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#compareTo-java.io.File-" title="class or interface in java.io" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#createNewFile--" title="class or interface in java.io" class="external-link">createNewFile</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#createTempFile-java.lang.String-java.lang.String-" title="class or interface in java.io" class="external-link">createTempFile</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#createTempFile-java.lang.String-java.lang.String-java.io.File-" title="class or interface in java.io" class="external-link">createTempFile</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#delete--" title="class or interface in java.io" class="external-link">delete</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#deleteOnExit--" title="class or interface in java.io" class="external-link">deleteOnExit</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#exists--" title="class or interface in java.io" class="external-link">exists</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#getAbsoluteFile--" title="class or interface in java.io" class="external-link">getAbsoluteFile</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#getAbsolutePath--" title="class or interface in java.io" class="external-link">getAbsolutePath</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#getCanonicalFile--" title="class or interface in java.io" class="external-link">getCanonicalFile</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#getCanonicalPath--" title="class or interface in java.io" class="external-link">getCanonicalPath</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#getFreeSpace--" title="class or interface in java.io" class="external-link">getFreeSpace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#getName--" title="class or interface in java.io" class="external-link">getName</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#getParent--" title="class or interface in java.io" class="external-link">getParent</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#getParentFile--" title="class or interface in java.io" class="external-link">getParentFile</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#getPath--" title="class or interface in java.io" class="external-link">getPath</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#getTotalSpace--" title="class or interface in java.io" class="external-link">getTotalSpace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#getUsableSpace--" title="class or interface in java.io" class="external-link">getUsableSpace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#isAbsolute--" title="class or interface in java.io" class="external-link">isAbsolute</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#isDirectory--" title="class or interface in java.io" class="external-link">isDirectory</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#isFile--" title="class or interface in java.io" class="external-link">isFile</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#isHidden--" title="class or interface in java.io" class="external-link">isHidden</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#lastModified--" title="class or interface in java.io" class="external-link">lastModified</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#length--" title="class or interface in java.io" class="external-link">length</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#list--" title="class or interface in java.io" class="external-link">list</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#list-java.io.FilenameFilter-" title="class or interface in java.io" class="external-link">list</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#listFiles--" title="class or interface in java.io" class="external-link">listFiles</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#listFiles-java.io.FileFilter-" title="class or interface in java.io" class="external-link">listFiles</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#listFiles-java.io.FilenameFilter-" title="class or interface in java.io" class="external-link">listFiles</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#listRoots--" title="class or interface in java.io" class="external-link">listRoots</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#mkdir--" title="class or interface in java.io" class="external-link">mkdir</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#mkdirs--" title="class or interface in java.io" class="external-link">mkdirs</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#renameTo-java.io.File-" title="class or interface in java.io" class="external-link">renameTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#setExecutable-boolean-" title="class or interface in java.io" class="external-link">setExecutable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#setExecutable-boolean-boolean-" title="class or interface in java.io" class="external-link">setExecutable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#setLastModified-long-" title="class or interface in java.io" class="external-link">setLastModified</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#setReadable-boolean-" title="class or interface in java.io" class="external-link">setReadable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#setReadable-boolean-boolean-" title="class or interface in java.io" class="external-link">setReadable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#setReadOnly--" title="class or interface in java.io" class="external-link">setReadOnly</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#setWritable-boolean-" title="class or interface in java.io" class="external-link">setWritable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#setWritable-boolean-boolean-" title="class or interface in java.io" class="external-link">setWritable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#toPath--" title="class or interface in java.io" class="external-link">toPath</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#toString--" title="class or interface in java.io" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#toURI--" title="class or interface in java.io" class="external-link">toURI</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#toURL--" title="class or interface in java.io" class="external-link">toURL</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.io.File,java.lang.String)"> |
| <h3>TextFile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TextFile</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> filename, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> encoding)</span></div> |
| <div class="block">Create a TextFile object to handle the named file with the given |
| encoding.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filename</code> - File to be read and written through this object.</dd> |
| <dd><code>encoding</code> - Encoding to be used when reading and writing this file.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.io.File)"> |
| <h3>TextFile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TextFile</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> filename)</span></div> |
| <div class="block">Create a TextFile object to handle the named file with the platform |
| default encoding.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filename</code> - File to be read and written through this object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String)"> |
| <h3>TextFile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TextFile</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> filename)</span></div> |
| <div class="block">Create a TextFile object to handle the named file with the platform |
| default encoding.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filename</code> - Name of the file to be read and written through this object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.String)"> |
| <h3>TextFile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TextFile</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> filename, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> encoding)</span></div> |
| <div class="block">Create a TextFile object to handle the named file with the given |
| encoding.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>filename</code> - Name of the file to be read and written through this object.</dd> |
| <dd><code>encoding</code> - Encoding to be used when reading and writing this file.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setText(java.lang.String)"> |
| <h3>setText</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setText</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> body)</span></div> |
| <div class="block">Create the file with the given string as content -- or replace its |
| content with the given string if the file already existed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>body</code> - New content for the file.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getText()"> |
| <h3>getText</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getText</span>()</div> |
| <div class="block">Read the whole file content and return it as a string.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the content of the file</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEncoding()"> |
| <h3>getEncoding</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getEncoding</span>()</div> |
| <div class="block">Returns encoding being used to read and write this file.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Encoding being used to read and write this file.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEncoding(java.lang.String)"> |
| <h3>setEncoding</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEncoding</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span></div> |
| <div class="block">Configures encoding to be used to read and write this file.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>string</code> - Encoding to be used to read and write this file.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#hashCode--" title="class or interface in java.io" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html#equals-java.lang.Object-" title="class or interface in java.io" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1998-2022 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |