| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>ArchiveEntryName (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: ArchiveEntryName"> |
| <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/ArchiveEntryName.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><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#constructor-detail">Constr</a></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><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"><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 ArchiveEntryName" class="title">Class ArchiveEntryName</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="DocumentName.html" title="class in org.apache.rat.document">org.apache.rat.document.DocumentName</a> |
| <div class="inheritance">org.apache.rat.document.ArchiveEntryName</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/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> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArchiveEntryName</span> |
| <span class="extends-implements">extends <a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></span></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="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.rat.document.DocumentName">Nested classes/interfaces inherited from class org.apache.rat.document.<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></h2> |
| <code><a href="DocumentName.Builder.html" title="class in org.apache.rat.document">DocumentName.Builder</a>, <a href="DocumentName.FSInfo.html" title="class in org.apache.rat.document">DocumentName.FSInfo</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(org.apache.rat.document.DocumentName,java.lang.String)" class="member-name-link">ArchiveEntryName</a><wbr>(<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a> archiveFileName, |
| <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> archiveEntryName)</code></div> |
| <div class="col-last even-row-color"> </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><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-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="#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 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="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></code></div> |
| <div class="col-second even-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 even-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> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.rat.document.DocumentName">Methods inherited from class org.apache.rat.document.<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></h3> |
| <code><a href="DocumentName.html#builder()">builder</a>, <a href="DocumentName.html#builder(java.io.File)">builder</a>, <a href="DocumentName.html#builder(java.nio.file.FileSystem)">builder</a>, <a href="DocumentName.html#builder(org.apache.rat.document.DocumentName)">builder</a>, <a href="DocumentName.html#builder(org.apache.rat.document.DocumentName.FSInfo)">builder</a>, <a href="DocumentName.html#compareTo(org.apache.rat.document.DocumentName)">compareTo</a>, <a href="DocumentName.html#equals(java.lang.Object)">equals</a>, <a href="DocumentName.html#getBaseDocumentName()">getBaseDocumentName</a>, <a href="DocumentName.html#getDirectorySeparator()">getDirectorySeparator</a>, <a href="DocumentName.html#getName()">getName</a>, <a href="DocumentName.html#getRoot()">getRoot</a>, <a href="DocumentName.html#getShortName()">getShortName</a>, <a href="DocumentName.html#hashCode()">hashCode</a>, <a href="DocumentName.html#isCaseSensitive()">isCaseSensitive</a>, <a href="DocumentName.html#localized()">localized</a>, <a href="DocumentName.html#toString()">toString</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>(org.apache.rat.document.DocumentName,java.lang.String)"> |
| <h3>ArchiveEntryName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ArchiveEntryName</span><wbr><span class="parameters">(<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a> archiveFileName, |
| <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> archiveEntryName)</span></div> |
| </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="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"><span class="description-from-type-label">Description copied from class: <code><a href="DocumentName.html#asFile()">DocumentName</a></code></span></div> |
| <div class="block">Creates a file from the document name.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="DocumentName.html#asFile()">asFile</a></code> in class <code><a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></code></dd> |
| <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"><span class="description-from-type-label">Description copied from class: <code><a href="DocumentName.html#asPath()">DocumentName</a></code></span></div> |
| <div class="block">Creates a path from the document name.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="DocumentName.html#asPath()">asPath</a></code> in class <code><a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></code></dd> |
| <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"><span class="description-from-type-label">Description copied from class: <code><a href="DocumentName.html#resolve(java.lang.String)">DocumentName</a></code></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>Overrides:</dt> |
| <dd><code><a href="DocumentName.html#resolve(java.lang.String)">resolve</a></code> in class <code><a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></code></dd> |
| <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>DocumentName.baseName</code>, directory sensitivity and case sensitivity as |
| this one.</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"><span class="description-from-type-label">Description copied from class: <code><a href="DocumentName.html#getBaseName()">DocumentName</a></code></span></div> |
| <div class="block">Gets the fully qualified basename of the document.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="DocumentName.html#getBaseName()">getBaseName</a></code> in class <code><a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the fully qualified basename of the document.</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"><span class="description-from-type-label">Description copied from class: <code><a href="DocumentName.html#localized(java.lang.String)">DocumentName</a></code></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>Overrides:</dt> |
| <dd><code><a href="DocumentName.html#localized(java.lang.String)">localized</a></code> in class <code><a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a></code></dd> |
| <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> |
| </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> |
