net.sourceforge.javadpkg.io.impl

Class FileMetaDataImpl

java.lang.Object

net.sourceforge.javadpkg.io.impl.FileMetaDataImpl

All Implemented Interfaces:

FileMetaData

public class FileMetaDataImpl
extends Object
implements FileMetaData

A FileMetaData implementation.

Version:

1.0, 12.05.2016 by Gerrit Hohl

Author:

Gerrit Hohl (gerrit-hohl@users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
FileMetaDataImpl(FileMetaData parent, String name, FileOwner owner, FileMode mode, Date lastModifiedDate) Creates the meta data of a directory.
FileMetaDataImpl(FileMetaData parent, String name, FileOwner owner, FileMode mode, long length, Date lastModifiedDate) Creates the meta data of a regular file.
FileMetaDataImpl(FileMetaData parent, String name, String targetPath, FileOwner owner, FileMode mode, Date lastModifiedDate) Creates the meta data of a symbolic link.
FileMetaDataImpl(String path, String name, FileOwner owner, FileMode mode, Date lastModifiedDate) Creates the meta data of a directory.
FileMetaDataImpl(String path, String name, FileOwner owner, FileMode mode, long length, Date lastModifiedDate) Creates the meta data of a regular file.
FileMetaDataImpl(String path, String name, String targetPath, FileOwner owner, FileMode mode, Date lastModifiedDate) Creates the meta data of a symbolic link.

Method Summary

Modifier and Type	Method and Description
static FileMetaData	createDirectoryMetaData(String absolutePath, FileOwner owner, FileMode mode, Date lastModifiedDate) Creates the meta data for a directory.
static FileMetaData	createFileMetaData(String absolutePath, FileOwner owner, FileMode mode, long length, Date lastModifiedDate) Creates the meta data for a regular file.
static FileMetaData	createSymbolicLinkMetaData(String absolutePath, String targetPath, FileOwner owner, FileMode mode, Date lastModifiedDate) Creates the meta data for a symbolic link.
String	getAbsolutePath() Returns the absolute path consisting of the path and the name of the file.
Date	getLastModifiedDate() Returns the timestamp of the last modification.
long	getLength() Returns the of the file in bytes.
FileMode	getMode() Returns the mode of the file.
String	getModeAsText() Returns the textual representation of the mode including the directory flag.
String	getName() Returns the name of the file.
FileOwner	getOwner() Returns the owner of the file.
String	getPath() Returns the path of the file excluding the name.
String	getTargetPath() Returns the target path of the symbolic link.
boolean	isDirectory() Returns the flag if the file is a directory.
boolean	isFile() Returns the flag if the file is a regular file.
boolean	isSymbolicLink() Returns the flag if the file is a symbolic link.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileMetaDataImpl

public FileMetaDataImpl(String path,
                        String name,
                        FileOwner owner,
                        FileMode mode,
                        Date lastModifiedDate)

Creates the meta data of a directory.

Parameters:

path - The path of the file excluding the name.

name - The name of the file.

owner - The owner of the file.

mode - The mode of the file.

lastModifiedDate - The timestamp of the last modification.

Throws:

IllegalArgumentException - If any of the parameters are null, the path is empty, the name contains a slash or is empty also the path is not "/".

FileMetaDataImpl

public FileMetaDataImpl(FileMetaData parent,
                        String name,
                        FileOwner owner,
                        FileMode mode,
                        Date lastModifiedDate)

Creates the meta data of a directory.

Parameters:

parent - The parent directory.

name - The name of the file.

owner - The owner of the file.

mode - The mode of the file.

lastModifiedDate - The timestamp of the last modification.

Throws:

IllegalArgumentException - If any of the parameters are null, the parent is not a directory, the name contains a slash or is empty.

FileMetaDataImpl

public FileMetaDataImpl(String path,
                        String name,
                        FileOwner owner,
                        FileMode mode,
                        long length,
                        Date lastModifiedDate)

Creates the meta data of a regular file.

Parameters:

path - The path of the file excluding the name.

name - The name of the file.

owner - The owner of the file.

mode - The mode of the file.

length - The length of the file or -1, if the length is unknown.

lastModifiedDate - The timestamp of the last modification.

Throws:

IllegalArgumentException - If any of the parameters are null, the path is empty, the name contains a slash, the name is empty or the length is less than -1.

FileMetaDataImpl

public FileMetaDataImpl(FileMetaData parent,
                        String name,
                        FileOwner owner,
                        FileMode mode,
                        long length,
                        Date lastModifiedDate)

Creates the meta data of a regular file.

Parameters:

parent - The parent directory.

name - The name of the file.

owner - The owner of the file.

mode - The mode of the file.

length - The length of the file or -1, if the length is unknown.

lastModifiedDate - The timestamp of the last modification.

Throws:

IllegalArgumentException - If any of the parameters are null, the parent is not a directory, the name contains a slash or the length is less than -1.

FileMetaDataImpl

public FileMetaDataImpl(String path,
                        String name,
                        String targetPath,
                        FileOwner owner,
                        FileMode mode,
                        Date lastModifiedDate)

Creates the meta data of a symbolic link.

Parameters:

path - The path of the file excluding the name.

name - The name of the file.

targetPath - The target path of the symbolic link.

owner - The owner of the file.

mode - The mode of the file.

lastModifiedDate - The timestamp of the last modification.

Throws:

IllegalArgumentException - If any of the parameters are null, the path is empty, the name contains a slash, the path is empty or if the target path is empty.

FileMetaDataImpl

public FileMetaDataImpl(FileMetaData parent,
                        String name,
                        String targetPath,
                        FileOwner owner,
                        FileMode mode,
                        Date lastModifiedDate)

Creates the meta data of a symbolic link.

Parameters:

parent - The parent directory.

name - The name of the file.

targetPath - The target path of the symbolic link.

owner - The owner of the file.

mode - The mode of the file.

lastModifiedDate - The timestamp of the last modification.

Throws:

IllegalArgumentException - If any of the parameters are null, the parent is not a directory, the name contains a slash, the name is empty or the target path is empty.

Method Detail

getPath

public String getPath()

Description copied from interface: FileMetaData

Returns the path of the file excluding the name.

Specified by:

getPath in interface FileMetaData

Returns:

The path.

See Also:

FileMetaData.getName(), FileMetaData.getAbsolutePath()

getName

public String getName()

Description copied from interface: FileMetaData

Returns the name of the file.

Specified by:

getName in interface FileMetaData

Returns:

The name.

See Also:

FileMetaData.getPath(), FileMetaData.getAbsolutePath()

getAbsolutePath

public String getAbsolutePath()

Description copied from interface: FileMetaData

Returns the absolute path consisting of the path and the name of the file.

If the file is a directory a trailing slash will be added.

Specified by:

getAbsolutePath in interface FileMetaData

Returns:

The absolute path.

See Also:

FileMetaData.getPath(), FileMetaData.getName()

isFile

public boolean isFile()

Description copied from interface: FileMetaData

Returns the flag if the file is a regular file.

A symbolic link is also a file.

Specified by:

isFile in interface FileMetaData

Returns:

The flag: true, if the file is a regular file, false otherwise.

See Also:

FileMetaData.isDirectory(), FileMetaData.isSymbolicLink()

isDirectory

public boolean isDirectory()

Description copied from interface: FileMetaData

Returns the flag if the file is a directory.

Specified by:

isDirectory in interface FileMetaData

Returns:

The flag: true, if the file is a directory, false otherwise.

See Also:

FileMetaData.isFile()

isSymbolicLink

public boolean isSymbolicLink()

Description copied from interface: FileMetaData

Returns the flag if the file is a symbolic link.

Specified by:

isSymbolicLink in interface FileMetaData

Returns:

The flag: true, if the file is a symbolic link, false otherwise.

See Also:

FileMetaData.isFile(), FileMetaData.getTargetPath()

getTargetPath

public String getTargetPath()

Description copied from interface: FileMetaData

Returns the target path of the symbolic link.

Specified by:

getTargetPath in interface FileMetaData

Returns:

The target path or null, if this meta data does not represent a symbolic link.

See Also:

FileMetaData.isSymbolicLink()

getOwner

public FileOwner getOwner()

Description copied from interface: FileMetaData

Returns the owner of the file.

Specified by:

getOwner in interface FileMetaData

Returns:

The owner.

getMode

public FileMode getMode()

Description copied from interface: FileMetaData

Returns the mode of the file.

Specified by:

getMode in interface FileMetaData

Returns:

The mode.

getModeAsText

public String getModeAsText()

Description copied from interface: FileMetaData

Returns the textual representation of the mode including the directory flag.

The returned value may look like this:

drwxrwxrwx

or like this:

----------

Specified by:

getModeAsText in interface FileMetaData

Returns:

The mode.

See Also:

FileMode.getText()

getLength

public long getLength()

Description copied from interface: FileMetaData

Returns the of the file in bytes.

Specified by:

getLength in interface FileMetaData

Returns:

The length or -1, if the length is unknown or the file is not a regular file.

getLastModifiedDate

public Date getLastModifiedDate()

Description copied from interface: FileMetaData

Returns the timestamp of the last modification.

Specified by:

getLastModifiedDate in interface FileMetaData

Returns:

The timestamp.

createDirectoryMetaData

public static FileMetaData createDirectoryMetaData(String absolutePath,
                                                   FileOwner owner,
                                                   FileMode mode,
                                                   Date lastModifiedDate)

Creates the meta data for a directory.

Parameters:

absolutePath - The absolute path.

owner - The owner of the file.

mode - The mode of the file.

lastModifiedDate - The timestamp of the last modification.

Returns:

The meta data.

Throws:

IllegalArgumentException - If any of the parameters are null or the absolute path is empty.

createFileMetaData

public static FileMetaData createFileMetaData(String absolutePath,
                                              FileOwner owner,
                                              FileMode mode,
                                              long length,
                                              Date lastModifiedDate)

Creates the meta data for a regular file.

Parameters:

absolutePath - The absolute path.

owner - The owner of the file.

mode - The mode of the file.

length - The length of the file or -1, if the length is unknown.

lastModifiedDate - The timestamp of the last modification.

Returns:

The meta data.

Throws:

IllegalArgumentException - If any of the parameters are null, the absolute path is empty or the length is less than -1.

createSymbolicLinkMetaData

public static FileMetaData createSymbolicLinkMetaData(String absolutePath,
                                                      String targetPath,
                                                      FileOwner owner,
                                                      FileMode mode,
                                                      Date lastModifiedDate)

Creates the meta data for a symbolic link.

Parameters:

absolutePath - The absolute path.

targetPath - The target path of the symbolic link.

owner - The owner of the symbolic link.

mode - The mode of the symbolic link.

lastModifiedDate - The timestamp of the last modification.

Returns:

The meta data.

Throws:

IllegalArgumentException - If any of the parameters are null, the absolute path is empty or the target is empty.