Package org.apache.rat.document

Class ArchiveEntryName

java.lang.Object

org.apache.rat.document.DocumentName

org.apache.rat.document.ArchiveEntryName

All Implemented Interfaces:

Comparable<DocumentName>

public class ArchiveEntryName
extends DocumentName

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.rat.document.DocumentName

DocumentName.Builder, DocumentName.FSInfo

Constructor Summary

Constructors

Constructor	Description
ArchiveEntryName(DocumentName archiveFileName, String archiveEntryName)

Method Summary

Modifier and Type	Method	Description
File	asFile()	Creates a file from the document name.
Path	asPath()	Creates a path from the document name.
String	getBaseName()	Gets the fully qualified basename of the document.
String	localized(String dirSeparator)	Gets the portion of the name that is not part of the base name.
DocumentName	resolve(String child)	Creates a new DocumentName by adding the child to the current name.

Methods inherited from class org.apache.rat.document.DocumentName

builder, builder, builder, builder, builder, compareTo, equals, getBaseDocumentName, getDirectorySeparator, getName, getRoot, getShortName, hashCode, isCaseSensitive, localized, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ArchiveEntryName

public ArchiveEntryName(DocumentName archiveFileName,
 String archiveEntryName)

Method Details

asFile

public File asFile()

Description copied from class: DocumentName

Creates a file from the document name.

Overrides:

asFile in class DocumentName

Returns:

a new File object.

asPath

public Path asPath()

Description copied from class: DocumentName

Creates a path from the document name.

Overrides:

asPath in class DocumentName

Returns:

a new Path object.

resolve

public DocumentName resolve(String child)

Description copied from class: DocumentName

Creates a new DocumentName by adding the child to the current name. Resulting documentName will have the same base name.

Overrides:

resolve in class DocumentName

Parameters:

child - the child to add (must use directory separator from this document name).

Returns:

the new document name with the same DocumentName.baseName, directory sensitivity and case sensitivity as this one.

getBaseName

public String getBaseName()

Description copied from class: DocumentName

Gets the fully qualified basename of the document.

Overrides:

getBaseName in class DocumentName

Returns:

the fully qualified basename of the document.

localized

public String localized(String dirSeparator)

Description copied from class: DocumentName

Gets the portion of the name that is not part of the base name. The resulting name will always start with the directory separator.

Overrides:

localized in class DocumentName

Parameters:

dirSeparator - The character(s) to use to separate directories in the result.

Returns:

the portion of the name that is not part of the base name.