URLFileSystemStorage (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

java.lang.Object
- oracle.ide.net.URLFileSystemStorage

All Implemented Interfaces:

Storage
```
public class URLFileSystemStorage
extends java.lang.Object
implements Storage
```
Storage that is URLFileSystem aware. Can be either a Directory storage or a File storage. You cannot read and write the same Storage at the same time!

Since:

12.1.2.0.0

Constructor Summary

Constructors
Constructor and Description

URLFileSystemStorage(java.net.URL url)
Initializes this storage

Constructors
Constructor and Description
`URLFileSystemStorage(java.net.URL url)` Initializes this storage

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close this Storage after reading or writing.
`Storage`	`create(java.lang.String name)` If this is a directory Storage, create a new file URLFileSystemStorage child of that directory
`Storage`	`createDir(java.lang.String name)` If this is a directory Storage, create a new directory URLFileSystemStorage child of that directory
`java.lang.String`	`getCanonicalPath()` Get the canonical path name of this Storage
`java.lang.String`	`getName()` Get the short name of this Storage
`java.lang.String`	`getPath()` Get the path of this Storage
`java.lang.Object`	`getProperty(java.lang.String property)` Get the value associated with the incoming property name as defined in this Storage
`java.net.URL`	`getURL()` Get the URL of this object.
`boolean`	`isDirectory()` Determine if this is a directory Storage
`boolean`	`isInJar()` Determine if this Storage is in a jar
`java.lang.String[]`	`list()` If this Storage is a directory, list the paths of all children of that directory.
`java.util.ArrayList`	`listStorage()` If this Storage is a directory, list all the children of that directory as Storages
`long`	`modDate()` Get the last modification date of this Storage
`void`	`open()` If this is a file Storage, open this Storage for reading or writing.
`Storage`	`open(java.lang.String name)` If this Storage is a directory, find the child with the incoming name of that directory and return it as a Storage.
`byte[]`	`read()` Read as many bytes as possible from this Storage.
`int`	`read(byte[] buf)` Read as many bytes as possible from this Storage up to the size of buf.
`void`	`setProperty(java.lang.String property, java.lang.Object value)` Set the value of a property in this Storage
`int`	`size()` Get the size of this Storage if it's a file URL Storage
`void`	`write(byte[] buf, int start, int len)` Write bytes to this Storage.

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

- Constructor Detail
  - URLFileSystemStorage
```
public URLFileSystemStorage(java.net.URL url)
```
    Initializes this storage
    
    Parameters:
    
    url - A non-null URL, which can be either a directory URL or a File URL
- Method Detail
  - getURL
```
public java.net.URL getURL()
```
    Get the URL of this object.
    
    Returns:
    
    The URL which will not be null
  - getName
```
public java.lang.String getName()
```
    Get the short name of this Storage
    
    Specified by:
    
    getName in interface Storage
    
    Returns:
    
    A short name
    
    See Also:
    
    URLFileSystem.getFileName(URL)
  - getPath
```
public java.lang.String getPath()
```
    Get the path of this Storage
    
    Specified by:
    
    getPath in interface Storage
    
    Returns:
    
    A path
    
    See Also:
    
    URLFileSystem.getPath(URL)
  - getCanonicalPath
```
public java.lang.String getCanonicalPath()
```
    Get the canonical path name of this Storage
    
    Specified by:
    
    getCanonicalPath in interface Storage
    
    Returns:
    
    A canonical path
    
    See Also:
    
    URLFileSystem.canonicalize(URL)
  - modDate
```
public long modDate()
```
    Get the last modification date of this Storage
    
    Specified by:
    
    modDate in interface Storage
    
    Returns:
    
    The last modification date
    
    See Also:
    
    URLFileSystem.lastModified(URL)
  - isDirectory
```
public boolean isDirectory()
```
    Determine if this is a directory Storage
    
    Specified by:
    
    isDirectory in interface Storage
    
    Returns:
    
    True if this Storage is a directory, false otherwise
    
    See Also:
    
    URLFileSystem.isDirectory(URL)
  - isInJar
```
public boolean isInJar()
```
    Determine if this Storage is in a jar
    
    Specified by:
    
    isInJar in interface Storage
    
    Returns:
    
    True if this Storage is in a jar, false otherwise
    
    See Also:
    
    JarUtil.isJarURL(URL)
  - getProperty
```
public java.lang.Object getProperty(java.lang.String property)
```
    Get the value associated with the incoming property name as defined in this Storage
    
    Specified by:
    
    getProperty in interface Storage
    
    Parameters:
    
    property - A name
    
    Returns:
    
    The value of the property if it exists, null otherwise
    
    See Also:
    
    setProperty(String, Object)
  - setProperty
```
public void setProperty(java.lang.String property,
                        java.lang.Object value)
```
    Set the value of a property in this Storage
    
    Specified by:
    
    setProperty in interface Storage
    
    Parameters:
    
    property - A name
    
    value - A value
    
    See Also:
    
    getProperty(String)
  - size
```
public int size()
```
    Get the size of this Storage if it's a file URL Storage
    
    Specified by:
    
    size in interface Storage
    
    Returns:
    
    0 if this is a directory Storage, otherwise the size of the file this Storage is based on
    
    See Also:
    
    URLFileSystem.getLength(URL)
  - read
```
public byte[] read()
            throws java.io.IOException
```
    Read as many bytes as possible from this Storage. You cannot read and write the same Storage at the same time
    
    Specified by:
    
    read in interface Storage
    
    Returns:
    
    An empty array if this is a directory Storage, otherwise an array with bytes read which might be empty
    
    Throws:
    
    java.io.IOException - in case of IOException
  - read
```
public int read(byte[] buf)
         throws java.io.IOException
```
    Read as many bytes as possible from this Storage up to the size of buf. You cannot read and write the same Storage at the same time
    
    Specified by:
    
    read in interface Storage
    
    Parameters:
    
    buf - The buffer to receive the bytes
    
    Returns:
    
    0 if this is a directory Storage, otherwise the number of bytes read
    
    Throws:
    
    java.io.IOException - in case of IOException
  - write
```
public void write(byte[] buf,
                  int start,
                  int len)
           throws java.io.IOException
```
    Write bytes to this Storage. You cannot read and write the same Storage at the same time. This method has no effect on a directory Storage.
    
    Specified by:
    
    write in interface Storage
    
    Parameters:
    
    buf - The buffer holding the bytes
    
    start - Where to start taking bytes
    
    len - How many bytes to write
    
    Throws:
    
    java.io.IOException - in case of IOException
  - list
```
public java.lang.String[] list()
```
    If this Storage is a directory, list the paths of all children of that directory.
    
    Specified by:
    
    list in interface Storage
    
    Returns:
    
    An empty array if this is a file Storage, otherwise an array of paths which might be empty
  - listStorage
```
public java.util.ArrayList listStorage()
```
    If this Storage is a directory, list all the children of that directory as Storages
    
    Specified by:
    
    listStorage in interface Storage
    
    Returns:
    
    An empty ArrayList if this is a file Storage, otherwise an ArrayList of Storages which might be empty
  - open
```
public void open()
          throws java.io.IOException
```
    If this is a file Storage, open this Storage for reading or writing. You cannot read and write the same Storage at the same time. This method has no effect on a directory Storage
    
    Specified by:
    
    open in interface Storage
    
    Throws:
    
    java.io.IOException - in case of an IOException
  - open
```
public Storage open(java.lang.String name)
```
    If this Storage is a directory, find the child with the incoming name of that directory and return it as a Storage. Despite the name of this method, the returned Storage is NOT opened... Caller needs to call open() before accessing the returned Storage for reading or writing
    
    Specified by:
    
    open in interface Storage
    
    Parameters:
    
    name - A name
    
    Returns:
    
    Null if this is a file Storage, otherwise a URLFileSystemStorage if this directory storage has a child with the incoming name or null if no such child exists
  - create
```
public Storage create(java.lang.String name)
```
    If this is a directory Storage, create a new file URLFileSystemStorage child of that directory
    
    Specified by:
    
    create in interface Storage
    
    Parameters:
    
    name - The name of the new child
    
    Returns:
    
    Null if this is a file Storage, otherwise a new file URLFileSystemStorage if a new child could be created
  - createDir
```
public Storage createDir(java.lang.String name)
```
    If this is a directory Storage, create a new directory URLFileSystemStorage child of that directory
    
    Specified by:
    
    createDir in interface Storage
    
    Parameters:
    
    name - The name of the new child
    
    Returns:
    
    Null if this is a file Storage, otherwise a new directory URLFileSystemStorage if a new child could be created
  - close
```
public void close()
```
    Close this Storage after reading or writing. This method HAS to be called after reading or writing so the streams are properly closed. Calling this method on a directory Storage has no effect
    
    Specified by:
    
    close in interface Storage

Class URLFileSystemStorage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

URLFileSystemStorage

Method Detail

getURL

getName

getPath

getCanonicalPath

modDate

isDirectory

isInJar

getProperty

setProperty

size

read

read

write

list

listStorage

open

open

create

createDir

close