| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>DocumentName (Apache Creadur RAT 0.17-SNAPSHOT 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.rat.document, class: DocumentName"> |
| <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"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.7.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 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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></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="class-use/DocumentName.html">Use</a></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> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li><a href="#nested-class-summary">Nested</a></li> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </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.rat.document</a></div> |
| <h1 title="Class DocumentName" class="title">Class DocumentName</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">org.apache.rat.document.DocumentName</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/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="ArchiveEntryName.html" title="class in org.apache.rat.document">ArchiveEntryName</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DocumentName</span> |
| <span class="extends-implements">extends <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> |
| implements <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="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>></span></div> |
| <div class="block">The name for a document. The <code>DocumentName</code> is an immutable structure that handles all the intricacies of file |
| naming on various operating systems. DocumentNames have several components: |
| <ul> |
| <li><code>root</code> - where in the file system the name starts (e.g C: on windows). May be empty but not null.</li> |
| <li><code>dirSeparator</code> - the separator between name segments (e.g. "\\" on windows, "/" on linux). May not be |
| empty or null.</li> |
| <li><code>name</code> - the name of the file relative to the <code>root</code>. May not be null. Does NOT begin with a <code>dirSeparator</code></li> |
| <li><code>baseName</code> - the name of a directory or file from which this file is reported. A DocumentName with a |
| <code>name</code> of "foo/bar/baz.txt" and a <code>baseName</code> of "foo" will be reported as "bar/baz.txt". May not be null.</li> |
| <li><code>isCaseSensitive</code> - identifies if the underlying file system is case-sensitive.</li> |
| </ul> |
| <p> |
| <code>DocumentName</code>s are generally used to represent files on the files system. However, they are also used to represent files |
| within an archive. When representing a file in an archive the baseName is the name of the enclosing archive document. |
| </p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final class </code></div> |
| <div class="col-second even-row-color"><code><a href="DocumentName.Builder.html" class="type-name-link" title="class in org.apache.rat.document">DocumentName.Builder</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The Builder for a DocumentName.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="DocumentName.FSInfo.html" class="type-name-link" title="class in org.apache.rat.document">DocumentName.FSInfo</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The file system information needed to process document names.</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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><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></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#asFile()" class="member-name-link">asFile</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a file from the document name.</div> |
| </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/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#asPath()" class="member-name-link">asPath</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a path from the document name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DocumentName.Builder.html" title="class in org.apache.rat.document">DocumentName.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder()" class="member-name-link">builder</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a Builder with the default file system info.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DocumentName.Builder.html" title="class in org.apache.rat.document">DocumentName.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder(java.io.File)" class="member-name-link">builder</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> file)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a builder from a File.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DocumentName.Builder.html" title="class in org.apache.rat.document">DocumentName.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder(java.nio.file.FileSystem)" class="member-name-link">builder</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystem.html" title="class or interface in java.nio.file" class="external-link">FileSystem</a> fileSystem)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a builder for the specified file system.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DocumentName.Builder.html" title="class in org.apache.rat.document">DocumentName.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder(org.apache.rat.document.DocumentName)" class="member-name-link">builder</a><wbr>(<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a> documentName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a builder from a document name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DocumentName.Builder.html" title="class in org.apache.rat.document">DocumentName.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder(org.apache.rat.document.DocumentName.FSInfo)" class="member-name-link">builder</a><wbr>(<a href="DocumentName.FSInfo.html" title="class in org.apache.rat.document">DocumentName.FSInfo</a> fsInfo)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a builder with the specified FSInfo instance.</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="#compareTo(org.apache.rat.document.DocumentName)" class="member-name-link">compareTo</a><wbr>(<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a> other)</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>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> other)</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="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBaseDocumentName()" class="member-name-link">getBaseDocumentName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the DocumentName for the basename of this DocumentName.</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="#getBaseName()" class="member-name-link">getBaseName</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the fully qualified basename of the document.</div> |
| </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="#getDirectorySeparator()" class="member-name-link">getDirectorySeparator</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 the directory separator.</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="#getName()" class="member-name-link">getName</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the fully qualified name of the document.</div> |
| </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="#getRoot()" class="member-name-link">getRoot</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the root for this document.</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="#getShortName()" class="member-name-link">getShortName</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the last segment of the name.</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCaseSensitive()" class="member-name-link">isCaseSensitive</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the case sensitivity flag.</div> |
| </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="#localized()" class="member-name-link">localized</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the portion of the name that is not part of the base name.</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="#localized(java.lang.String)" class="member-name-link">localized</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> dirSeparator)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the portion of the name that is not part of the base name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resolve(java.lang.String)" class="member-name-link">resolve</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> child)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a new DocumentName by adding the child to the current name.</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="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the localized file name.</div> |
| </div> |
| </div> |
| </div> |
| </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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="builder()"> |
| <h3>builder</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DocumentName.Builder.html" title="class in org.apache.rat.document">DocumentName.Builder</a></span> <span class="element-name">builder</span>()</div> |
| <div class="block">Creates a Builder with the default file system info.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the builder.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="DocumentName.FSInfo.html" title="class in org.apache.rat.document"><code>DocumentName.FSInfo</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="builder(org.apache.rat.document.DocumentName.FSInfo)"> |
| <h3>builder</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DocumentName.Builder.html" title="class in org.apache.rat.document">DocumentName.Builder</a></span> <span class="element-name">builder</span><wbr><span class="parameters">(<a href="DocumentName.FSInfo.html" title="class in org.apache.rat.document">DocumentName.FSInfo</a> fsInfo)</span></div> |
| <div class="block">Creates a builder with the specified FSInfo instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fsInfo</code> - the FSInfo to use for the builder.</dd> |
| <dt>Returns:</dt> |
| <dd>a new builder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="builder(java.nio.file.FileSystem)"> |
| <h3>builder</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DocumentName.Builder.html" title="class in org.apache.rat.document">DocumentName.Builder</a></span> <span class="element-name">builder</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystem.html" title="class or interface in java.nio.file" class="external-link">FileSystem</a> fileSystem)</span></div> |
| <div class="block">Creates a builder for the specified file system.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fileSystem</code> - the file system to create the builder on.</dd> |
| <dt>Returns:</dt> |
| <dd>a new builder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="builder(java.io.File)"> |
| <h3>builder</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DocumentName.Builder.html" title="class in org.apache.rat.document">DocumentName.Builder</a></span> <span class="element-name">builder</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> file)</span></div> |
| <div class="block">Creates a builder from a File. The <code>baseName</code> is set to the file name if it is a directory otherwise |
| it is set to the directory containing the file.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>file</code> - The file to set defaults from.</dd> |
| <dt>Returns:</dt> |
| <dd>the builder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="builder(org.apache.rat.document.DocumentName)"> |
| <h3>builder</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DocumentName.Builder.html" title="class in org.apache.rat.document">DocumentName.Builder</a></span> <span class="element-name">builder</span><wbr><span class="parameters">(<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a> documentName)</span></div> |
| <div class="block">Creates a builder from a document name. The builder will be configured to create a clone of the DocumentName.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>documentName</code> - the document name to set the defaults from.</dd> |
| <dt>Returns:</dt> |
| <dd>the builder.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="asFile()"> |
| <h3>asFile</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/io/File.html" title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name">asFile</span>()</div> |
| <div class="block">Creates a file from the document name.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a new File object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="asPath()"> |
| <h3>asPath</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/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a></span> <span class="element-name">asPath</span>()</div> |
| <div class="block">Creates a path from the document name.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a new Path object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="resolve(java.lang.String)"> |
| <h3>resolve</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></span> <span class="element-name">resolve</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> child)</span></div> |
| <div class="block">Creates a new DocumentName by adding the child to the current name. |
| Resulting documentName will have the same base name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>child</code> - the child to add (must use directory separator from this document name).</dd> |
| <dt>Returns:</dt> |
| <dd>the new document name with the same <code>baseName</code>, directory sensitivity and case sensitivity as |
| this one.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getName()"> |
| <h3>getName</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">getName</span>()</div> |
| <div class="block">Gets the fully qualified name of the document.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the fully qualified name of the document.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBaseName()"> |
| <h3>getBaseName</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">getBaseName</span>()</div> |
| <div class="block">Gets the fully qualified basename of the document.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the fully qualified basename of the document.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRoot()"> |
| <h3>getRoot</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">getRoot</span>()</div> |
| <div class="block">Gets the root for this document.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the root for this document.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBaseDocumentName()"> |
| <h3>getBaseDocumentName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></span> <span class="element-name">getBaseDocumentName</span>()</div> |
| <div class="block">Gets the DocumentName for the basename of this DocumentName.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the DocumentName for the basename of this document name.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDirectorySeparator()"> |
| <h3>getDirectorySeparator</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">getDirectorySeparator</span>()</div> |
| <div class="block">Returns the directory separator.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the directory separator.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="localized()"> |
| <h3>localized</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">localized</span>()</div> |
| <div class="block">Gets the portion of the name that is not part of the base name. |
| The resulting name will always start with the directory separator.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the portion of the name that is not part of the base name.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="localized(java.lang.String)"> |
| <h3>localized</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">localized</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> dirSeparator)</span></div> |
| <div class="block">Gets the portion of the name that is not part of the base name. |
| The resulting name will always start with the directory separator.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dirSeparator</code> - The character(s) to use to separate directories in the result.</dd> |
| <dt>Returns:</dt> |
| <dd>the portion of the name that is not part of the base name.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getShortName()"> |
| <h3>getShortName</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">getShortName</span>()</div> |
| <div class="block">Gets the last segment of the name. This is the part after the last directory separator.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the last segment of the name.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isCaseSensitive()"> |
| <h3>isCaseSensitive</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isCaseSensitive</span>()</div> |
| <div class="block">Gets the case sensitivity flag.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the name is case-sensitive.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</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">toString</span>()</div> |
| <div class="block">Returns the localized file name.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><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></code></dd> |
| <dt>Returns:</dt> |
| <dd>the localized file name.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="compareTo(org.apache.rat.document.DocumentName)"> |
| <h3>compareTo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">compareTo</span><wbr><span class="parameters">(<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a> other)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html#compareTo-T-" title="class or interface in java.lang" class="external-link">compareTo</a></code> in interface <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="DocumentName.html" title="class in org.apache.rat.document">DocumentName</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> other)</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><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></code></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/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><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></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 © 2006–2025 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
