VCSFileProxy (Versioning Core)

java.lang.Object
- org.netbeans.modules.versioning.core.api.VCSFileProxy

All Implemented Interfaces:: Comparable<VCSFileProxy>

public final class VCSFileProxy
extends Object
implements Comparable<VCSFileProxy>

Represents a file on a file system.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canWrite()` Determines whether this file is writable or not.
`int`	`compareTo(VCSFileProxy o)`
`static VCSFileProxy`	`createFileProxy(File file)` Creates a VCSFileProxy based on io.File.
`static VCSFileProxy`	`createFileProxy(FileObject fileObject)` Creates a VCSFileProxy based on the given `FileObject`.
`static VCSFileProxy`	`createFileProxy(URI uri)`
`static VCSFileProxy`	`createFileProxy(VCSFileProxy parent, String child)` Creates a new VCSFileProxy from the given parent and child name
`boolean`	`equals(Object obj)`
`boolean`	`exists()` Determines whether this file exists or not.
`InputStream`	`getInputStream(boolean checkLock)`
`String`	`getName()` Returns the name of this file.
`VCSFileProxy`	`getParentFile()` Returns this files parent or `null` if this file doesn't have a parent.
`String`	`getPath()` Determines this files path.
`int`	`hashCode()`
`boolean`	`isDirectory()` Determines whether this file is a directory or not.
`boolean`	`isFile()` Determines whether this file is a normal file or not.
`long`	`lastModified()` Determines the last time this file was modified.
`VCSFileProxy[]`	`listFiles()` Returns an array of files located in a directory given by this file.
`VCSFileProxy`	`normalizeFile()` Normalize a file path to a clean form.
`File`	`toFile()` Returns the corresponding java.io.File in case this instance was created based either on java.io.File or a `FileObject` based on java.io.File.
`FileObject`	`toFileObject()` Returns the corresponding FileObject.
`String`	`toString()`
`URI`	`toURI()` Determines this files URI.

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

- Method Detail
  - createFileProxy
```
public static VCSFileProxy createFileProxy(File file)
```
    Creates a VCSFileProxy based on io.File.
    
    Parameters:
    
    file - the file to be represented by VCSFileProxy
    
    Returns:
    
    a VCSFileProxy representing the given file
  - createFileProxy
```
public static VCSFileProxy createFileProxy(VCSFileProxy parent,
                                           String child)
```
    Creates a new VCSFileProxy from the given parent and child name
    
    Parameters:
    
    parent - the parent file
    
    child - the child name
    
    Returns:
    
    a VCSFileProxy representing the a file given by the parent and child values
  - createFileProxy
```
public static VCSFileProxy createFileProxy(URI uri)
```
  - createFileProxy
```
public static VCSFileProxy createFileProxy(FileObject fileObject)
```
    Creates a VCSFileProxy based on the given FileObject. In case there is a corresponding java.io.File to the FileObject the the io.File will be used as in VCSFileProxy.createFileProxy(java.io.File).
    
    Parameters:
    
    fileObject - the file to be represented by VCSFileProxy
    
    Returns:
    
    a VCSFileProxy representing the given file or null if the given FileObject-s Filesystem isn't supported - e.g. jar filesystem.
  - getPath
```
public String getPath()
```
    Determines this files path. Depending on its origin it will be either FileObject.getPath() or File.getAbsoluteFile().
    
    Returns:
    
    this files path
    
    See Also:
    
    File.getPath(), FileObject.getPath()
  - toURI
```
public URI toURI()
          throws URISyntaxException
```
    Determines this files URI. Depending on its origin it will be either FileObject.toURI() or File.toURI().
    
    Returns:
    
    this file URI
    
    Throws:
    
    URISyntaxException
    
    See Also:
    
    File.toURI(), FileObject.toURI()
  - getName
```
public String getName()
```
    Returns the name of this file.
    
    Returns:
    
    this files name
    
    See Also:
    
    ()
  - isDirectory
```
public boolean isDirectory()
```
    Determines whether this file is a directory or not. This method might block for a longer time and shouldn't be called in EDT.
    
    Returns:
    
    true if this file exists and is a directory, otherwise false
    
    See Also:
    
    File.isDirectory()
  - isFile
```
public boolean isFile()
```
    Determines whether this file is a normal file or not. This method might block for a longer time and shouldn't be called in EDT.
    
    Returns:
    
    true if this file is a normal file, otherwise false
    
    See Also:
    
    File.isFile()
  - canWrite
```
public boolean canWrite()
```
    Determines whether this file is writable or not. This method might block for a longer time and shouldn't be called in EDT.
    
    Returns:
    
    true if this file is writable, otherwise false
    
    See Also:
    
    File.canWrite()
  - lastModified
```
public long lastModified()
```
    Determines the last time this file was modified. This method might block for a longer time and shouldn't be called in EDT.
    
    Returns:
    
    A long value representing the time the file was last modified.
    
    See Also:
    
    File.lastModified()
  - getParentFile
```
public VCSFileProxy getParentFile()
```
    Returns this files parent or null if this file doesn't have a parent. This method might block for a longer time and shouldn't be called in EDT.
    
    Returns:
    
    this files parent
    
    See Also:
    
    File.getParentFile()
  - getInputStream
```
public InputStream getInputStream(boolean checkLock)
                           throws FileNotFoundException
```
    Throws:
    
    FileNotFoundException
  - exists
```
public boolean exists()
```
    Determines whether this file exists or not. This method might block for a longer time and shouldn't be called in EDT.
    
    Returns:
    
    true if this files exists, otherwise false
    
    See Also:
    
    File.exists()
  - listFiles
```
public VCSFileProxy[] listFiles()
```
    Returns an array of files located in a directory given by this file. This method might block for a longer time and shouldn't be called in EDT.
    
    Returns:
    
    an array of files located in a directory given by this file or null if this file isn't a directory or an error occurs.
    
    See Also:
    
    File.listFiles()
  - toFile
```
public File toFile()
```
    Returns the corresponding java.io.File in case this instance was created based either on java.io.File or a FileObject based on java.io.File. This method might block for a longer time and shouldn't be called in EDT.
    
    Returns:
    
    the corresponding java.io.File instance or null if none is available.
    
    See Also:
    
    VCSFileProxy.createFileProxy(java.io.File), VCSFileProxy.createFileProxy(org.openide.filesystems.FileObject)
  - toFileObject
```
public FileObject toFileObject()
```
    Returns the corresponding FileObject. This method might block for a longer time and shouldn't be called in EDT.
    
    Returns:
    
    the corresponding FileObject or null if none available
  - normalizeFile
```
public VCSFileProxy normalizeFile()
```
    Normalize a file path to a clean form. This method might block for a longer time and shouldn't be called in EDT.
    
    Returns:
    
    a VCSFileProxy with a normalized file path
    
    See Also:
    
    FileUtil.normalizePath(java.lang.String)
  - compareTo
```
public int compareTo(VCSFileProxy o)
```
    Specified by:
    
    compareTo in interface Comparable<VCSFileProxy>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class VCSFileProxy

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createFileProxy

createFileProxy

createFileProxy

createFileProxy

getPath

toURI

getName

isDirectory

isFile

canWrite

lastModified

getParentFile

getInputStream

exists

listFiles

toFile

toFileObject

normalizeFile

compareTo

toString

hashCode

equals