MFileOS7 (NetCDF-Java All API v5.7.0)

java.lang.Object
- thredds.filesystem.MFileOS7

All Implemented Interfaces:

java.lang.Comparable<MFile>, MFile
```
@ThreadSafe
public class MFileOS7
extends java.lang.Object
implements MFile
```
Use Java 7 nio Paths

Since:

11/16/13

Constructor Summary

Constructors
Constructor and Description
`MFileOS7(java.nio.file.Path path)`
`MFileOS7(java.nio.file.Path path, java.nio.file.attribute.BasicFileAttributes attr)`
`MFileOS7(java.lang.String filename)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(MFile o)`
`boolean`	`exists()` Check if the MFile exists
`java.lang.Object`	`getAuxInfo()`
`MFileOS7`	`getChild(java.lang.String newFilename)` Get child MFile of this MFile
`static MFileOS7`	`getExistingFile(java.lang.String filename)` Make MFileOS7 if file exists, otherwise return null
`java.io.FileInputStream`	`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.
`java.nio.file.Path`	`getNioPath()`
`MFile`	`getParent()` Get the parent of this
`java.lang.String`	`getPath()` Get full path name, replace \\ with /
`boolean`	`isDirectory()`
`boolean`	`isReadable()`
`java.lang.String`	`relativize(MFile other)` Construct a relative path between this MFile and a given MFile.
`void`	`setAuxInfo(java.lang.Object auxInfo)`
`java.lang.String`	`toString()`
`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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface thredds.inventory.MFile
isZipFile

- Constructor Detail
  - MFileOS7
```
public MFileOS7(java.nio.file.Path path)
         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - MFileOS7
```
public MFileOS7(java.nio.file.Path path,
                java.nio.file.attribute.BasicFileAttributes attr)
```
  - MFileOS7
```
public MFileOS7(java.lang.String filename)
         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - getExistingFile
```
public static MFileOS7 getExistingFile(java.lang.String filename)
                                throws java.io.IOException
```
    Make MFileOS7 if file exists, otherwise return null
    
    Parameters:
    
    filename - full path name
    
    Returns:
    
    MFileOS or null
    
    Throws:
    
    java.io.IOException
  - getLastModified
```
public long getLastModified()
```
    Description copied from interface: MFile
    
    Get time of last modification at the time the MFile object was created
    
    Specified by:
    
    getLastModified in interface MFile
    
    Returns:
    
    time of last modification in Unix time (msecs since reference), or -1 if unknown
  - getLength
```
public long getLength()
```
    Description copied from interface: MFile
    
    Size of file in bytes
    
    Specified by:
    
    getLength in interface MFile
    
    Returns:
    
    Size of file in bytes or -1 if unknown
  - isDirectory
```
public boolean isDirectory()
```
    Specified by:
    
    isDirectory in interface MFile
  - isReadable
```
public boolean isReadable()
```
    Specified by:
    
    isReadable in interface MFile
  - getPath
```
public java.lang.String getPath()
```
    Description copied from interface: MFile
    
    Get full path name, replace \\ with /
    
    Specified by:
    
    getPath in interface MFile
    
    Returns:
    
    full path name
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: MFile
    
    The name is the farthest element from the root in the directory hierarchy.
    
    Specified by:
    
    getName in interface MFile
    
    Returns:
    
    the file name
  - getParent
```
public MFile getParent()
                throws java.io.IOException
```
    Description copied from interface: MFile
    
    Get the parent of this
    
    Specified by:
    
    getParent in interface MFile
    
    Returns:
    
    the parent or null
    
    Throws:
    
    java.io.IOException
  - compareTo
```
public int compareTo(MFile o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<MFile>
    
    Specified by:
    
    compareTo in interface MFile
  - getAuxInfo
```
public java.lang.Object getAuxInfo()
```
    Specified by:
    
    getAuxInfo in interface MFile
  - setAuxInfo
```
public void setAuxInfo(java.lang.Object auxInfo)
```
    Specified by:
    
    setAuxInfo in interface MFile
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - exists
```
public boolean exists()
```
    Description copied from interface: MFile
    
    Check if the MFile exists
    
    Specified by:
    
    exists in interface MFile
    
    Returns:
    
    true if the MFile exists, else false
  - getInputStream
```
public java.io.FileInputStream getInputStream()
                                       throws java.io.FileNotFoundException
```
    Description copied from interface: MFile
    
    Get the MFile InputStream
    
    Specified by:
    
    getInputStream in interface MFile
    
    Returns:
    
    the MFile InputStream
    
    Throws:
    
    java.io.FileNotFoundException
  - writeToStream
```
public void writeToStream(java.io.OutputStream outputStream)
                   throws java.io.IOException
```
    Description copied from interface: MFile
    
    Write the MFile to an OutputStream
    
    Specified by:
    
    writeToStream in interface MFile
    
    Parameters:
    
    outputStream - the OutputStream the MFile contents should be written to
    
    Throws:
    
    java.io.IOException
  - writeToStream
```
public void writeToStream(java.io.OutputStream outputStream,
                          long offset,
                          long maxBytes)
                   throws java.io.IOException
```
    Description copied from interface: MFile
    
    Write the MFile to an OutputStream
    
    Specified by:
    
    writeToStream in interface MFile
    
    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
```
public MFileOS7 getChild(java.lang.String newFilename)
```
    Description copied from interface: MFile
    
    Get child MFile of this MFile
    
    Specified by:
    
    getChild in interface MFile
    
    Parameters:
    
    newFilename - the relative file path of the new MFile
    
    Returns:
    
    the new MFile or null if the file can't be resolved
  - getNioPath
```
public java.nio.file.Path getNioPath()
```
  - relativize
```
public java.lang.String relativize(MFile other)
```
    Description copied from interface: MFile
    
    Construct a relative path between this MFile and a given MFile.
    
    Specified by:
    
    relativize in interface 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

Class MFileOS7

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface thredds.inventory.MFile

Constructor Detail

MFileOS7

MFileOS7

MFileOS7

Method Detail

getExistingFile

getLastModified

getLength

isDirectory

isReadable

getPath

getName

getParent

compareTo

getAuxInfo

setAuxInfo

toString

exists

getInputStream

writeToStream

writeToStream

getChild

getNioPath

relativize