com.groupdocs.viewer.options

Class FileName

java.lang.Object

com.groupdocs.viewer.options.FileName

public class FileName
extends Object

Represents the name of a file in an archive.

The FileName class encapsulates the name of a file without any path or directory information. It provides methods to manipulate and retrieve information about the file name.

Example usage:

 HtmlViewOptions options = HtmlViewOptions.forEmbeddedResources();
 options.getArchiveOptions().setFileName(new FileName("my-file-name"));

 final LoadOptions loadOptions = new LoadOptions(FileType.ZIP);
 try (final Viewer viewer = new Viewer(documentPath, loadOptions)) {
     viewer.view(options);
     // Use the viewer object for archive document rendering
 }
 

Note: The FileName class is used to work with file names and does not handle file operations or manipulation.

See Also:

HtmlViewOptions, LoadOptions, Viewer

Field Summary

Fields

Modifier and Type	Field and Description
static FileName	EMPTY Represents an empty filename.
static FileName	SOURCE Represents the name of the source file.

Constructor Summary

Constructors

Constructor and Description
FileName(String fileName) Initializes a new instance of the FileName class.

Method Summary

Modifier and Type	Method and Description
String	getText()
String	toString() Returns a string representation of the current object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final FileName EMPTY

Represents an empty filename.

SOURCE

public static final FileName SOURCE

Represents the name of the source file.

Constructor Detail

FileName

public FileName(String fileName)

Initializes a new instance of the FileName class.

Parameters:

fileName - The name of the file.

Method Detail

getText

public String getText()

toString

public String toString()

Returns a string representation of the current object.

Overrides:

toString in class Object

Returns:

a string representation of the current object.