org.cripac.isee.vpe.util.tracking

Class FileDescriptor

java.lang.Object

org.cripac.isee.vpe.util.tracking.FileDescriptor

public class FileDescriptor
extends java.lang.Object

The FileDescriptor stores the folder hierarchy and NAME of a file.

Constructor Summary

Constructors

Constructor and Description
FileDescriptor(java.lang.String name) Create a configuration file descriptor with its NAME.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConcatName() Get the concatenated NAME of this configuration file containing all the information of the hierarchy.
java.lang.String	getPath() Get the path of this configuration file relative to the most upper folder known to the descriptor.
FileDescriptor	wrap(java.lang.String folderName) Indicate that the given folder further contains the containing folder hierarchy of this configuration file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDescriptor

public FileDescriptor(@Nonnull
                      java.lang.String name)

Create a configuration file descriptor with its NAME.

Parameters:

name - The NAME of the configuration file.

Method Detail

wrap

public FileDescriptor wrap(@Nonnull
                           java.lang.String folderName)

Indicate that the given folder further contains the containing folder hierarchy of this configuration file.

Parameters:

folderName - The NAME of the outer folder.

Returns:

The descriptor itself.

getPath

public java.lang.String getPath()

Get the path of this configuration file relative to the most upper folder known to the descriptor.

Returns:

The relative path of this configuraiton file.

getConcatName

public java.lang.String getConcatName()

Get the concatenated NAME of this configuration file containing all the information of the hierarchy.

Returns:

The concatenated NAME.