thredds.inventory

Interface MFile

All Superinterfaces:

java.lang.Comparable<MFile>

All Known Implementing Classes:

GcMFile, MFileOS, MFileOS7, MFileS3, MFileZip

public interface MFile
extends java.lang.Comparable<MFile>

An abstraction for java.io.File / java.nio.file.Path

Since:

Jun 30, 2009

Method Summary

Modifier and Type	Method and Description
int	compareTo(MFile o)
boolean	exists() Check if the MFile exists
java.lang.Object	getAuxInfo()
MFile	getChild(java.lang.String newFileName) Get child MFile of this MFile
java.io.InputStream	getInputStream() Get the MFile InputStream
long	getLastModified() Get time of last modification at the time the MFile object was created
long	getLength() Size of file in bytes
java.lang.String	getName() The name is the farthest element from the root in the directory hierarchy.
MFile	getParent() Get the parent of this
java.lang.String	getPath() Get full path name, replace \\ with /
boolean	isDirectory()
default boolean	isReadable()
default boolean	isZipFile() Check if this MFile is a zip file
java.lang.String	relativize(MFile other) Construct a relative path between this MFile and a given MFile.
void	setAuxInfo(java.lang.Object info)
void	writeToStream(java.io.OutputStream outputStream) Write the MFile to an OutputStream
void	writeToStream(java.io.OutputStream outputStream, long offset, long maxBytes) Write the MFile to an OutputStream

Method Detail

getLastModified

long getLastModified()

Get time of last modification at the time the MFile object was created

Returns:

time of last modification in Unix time (msecs since reference), or -1 if unknown

getLength

long getLength()

Size of file in bytes

Returns:

Size of file in bytes or -1 if unknown

isDirectory

boolean isDirectory()

isZipFile

default boolean isZipFile()

Check if this MFile is a zip file

Returns:

true if the MFile is a zip file

isReadable

default boolean isReadable()

getPath

java.lang.String getPath()

Get full path name, replace \\ with /

Returns:

full path name

getName

java.lang.String getName()

The name is the farthest element from the root in the directory hierarchy.

Returns:

the file name

getParent

MFile getParent()
         throws java.io.IOException

Get the parent of this

Returns:

the parent or null

Throws:

java.io.IOException

compareTo

int compareTo(MFile o)

Specified by:

compareTo in interface java.lang.Comparable<MFile>

getAuxInfo

java.lang.Object getAuxInfo()

setAuxInfo

void setAuxInfo(java.lang.Object info)

exists

boolean exists()

Check if the MFile exists

Returns:

true if the MFile exists, else false

getInputStream

java.io.InputStream getInputStream()
                            throws java.io.FileNotFoundException

Get the MFile InputStream

Returns:

the MFile InputStream

Throws:

java.io.FileNotFoundException

writeToStream

void writeToStream(java.io.OutputStream outputStream)
            throws java.io.IOException

Write the MFile to an OutputStream

Parameters:

outputStream - the OutputStream the MFile contents should be written to

Throws:

java.io.IOException

writeToStream

void writeToStream(java.io.OutputStream outputStream,
                   long offset,
                   long maxBytes)
            throws java.io.IOException

Write the MFile to an OutputStream

Parameters:

outputStream - the OutputStream the MFile contents should be written to

offset - the index of the first byte to write out

maxBytes - the maximum number of bytes to copy

Throws:

java.io.IOException

getChild

@Nullable
MFile getChild(java.lang.String newFileName)

Get child MFile of this MFile

Parameters:

newFileName - the relative file path of the new MFile

Returns:

the new MFile or null if the file can't be resolved

relativize

java.lang.String relativize(MFile other)

Construct a relative path between this MFile and a given MFile.

Parameters:

other - the MFile to relativize against this MFile's path

Returns:

the resulting relative path as a String, or an empty path if both paths are equal