Folder (milton-client 3.1.0.301 API)

java.lang.Object
- io.milton.httpclient.Resource
- - io.milton.httpclient.Folder

Direct Known Subclasses:

Host
```
public class Folder
extends Resource
```
Author:

mcevoyb

Field Summary

Fields
Modifier and Type Field and Description

protected Map<Folder,List<Resource>> cache
- Fields inherited from class io.milton.httpclient.Resource
  displayName, name, parent

Fields
Modifier and Type	Field and Description
`protected Map<Folder,List<Resource>>`	`cache`

Constructor Summary

Constructors
Constructor and Description
`Folder(Folder parent, PropFindResponse resp, Map<Folder,List<Resource>> cache)`
`Folder(Folder parent, String name, Map<Folder,List<Resource>> cache)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(FolderListener l)`
`Resource`	`child(String childName)`
`List<? extends Resource>`	`children()`
`Folder`	`createFolder(String name)`
`File`	`downloadTo(File destFolder, ProgressListener listener)`
`String`	`encodedUrl()`
`void`	`flush()` Empty the cached children for this folder
`Resource`	`getChild(int num)`
`boolean`	`hasChildren()`
`String`	`href()` Returns the UN-encoded url
`int`	`numChildren()`
`String`	`post(String relativePath, Map<String,String> params)`
`void`	`removeListener(FolderListener folderListener)`
`String`	`toString()`
`void`	`upload(File f)`
`void`	`upload(File f, ProgressListener listener)`
`File`	`upload(String name, InputStream content, Integer contentLength, ProgressListener listener)`
`File`	`upload(String name, InputStream content, Long contentLength, ProgressListener listener)` Upload a new file
`File`	`upload(String name, InputStream content, Long contentLength, String contentType, IfMatchCheck matchCheck, ProgressListener listener)`
`File`	`uploadFile(File f)`
`File`	`uploadFile(File f, ProgressListener listener)` Load a new file into this folder, and return a reference
`File`	`uploadFile(String newName, File f, ProgressListener listener)` Upload a new file
`protected void`	`uploadFolder(File folder, ProgressListener listener)`

Methods inherited from class io.milton.httpclient.Resource
addListener, copyTo, copyTo, decodePath, delete, encodedName, finalize, getCount, getCreatedDate, getLockOwner, getLockToken, getModifiedDate, host, lock, lock, moveTo, moveTo, path, post, removeListener, rename, unlock

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

Field Detail

cache

protected final Map<Folder,List<Resource>> cache

Constructor Detail

Folder

public Folder(Folder parent,
              PropFindResponse resp,
              Map<Folder,List<Resource>> cache)

Folder

public Folder(Folder parent,
              String name,
              Map<Folder,List<Resource>> cache)

Method Detail

addListener

public void addListener(FolderListener l)
                 throws IOException,
                        HttpException,
                        NotAuthorizedException,
                        BadRequestException

Throws:: IOException; HttpException; NotAuthorizedException; BadRequestException

post

public String post(String relativePath,
                   Map<String,String> params)
            throws HttpException,
                   NotAuthorizedException,
                   ConflictException,
                   BadRequestException,
                   NotFoundException

Parameters:: relativePath - - encoded but relative path. Must not start with a slash; params -
Returns:
Throws:: HttpException; NotAuthorizedException; ConflictException; BadRequestException; NotFoundException

downloadTo

public File downloadTo(File destFolder,
                       ProgressListener listener)
                throws IOException,
                       HttpException,
                       NotAuthorizedException,
                       BadRequestException

Specified by:: downloadTo in class Resource
Throws:: IOException; HttpException; NotAuthorizedException; BadRequestException

flush
```
public void flush()
           throws IOException
```
Empty the cached children for this folder

Throws:

IOException

hasChildren

public boolean hasChildren()
                    throws IOException,
                           HttpException,
                           NotAuthorizedException,
                           BadRequestException

Throws:: IOException; HttpException; NotAuthorizedException; BadRequestException

numChildren

public int numChildren()
                throws IOException,
                       HttpException,
                       NotAuthorizedException,
                       BadRequestException

Throws:: IOException; HttpException; NotAuthorizedException; BadRequestException

children

public List<? extends Resource> children()
                                  throws IOException,
                                         HttpException,
                                         NotAuthorizedException,
                                         BadRequestException

Throws:: IOException; HttpException; NotAuthorizedException; BadRequestException

getChild

public Resource getChild(int num)
                  throws IOException,
                         HttpException,
                         NotAuthorizedException,
                         BadRequestException

Throws:: IOException; HttpException; NotAuthorizedException; BadRequestException

removeListener

public void removeListener(FolderListener folderListener)

toString
```
public String toString()
```
Overrides:

toString in class Resource

upload

public void upload(File f)
            throws IOException,
                   HttpException,
                   NotAuthorizedException,
                   ConflictException,
                   BadRequestException,
                   NotFoundException

Throws:: IOException; HttpException; NotAuthorizedException; ConflictException; BadRequestException; NotFoundException

upload

public void upload(File f,
                   ProgressListener listener)
            throws IOException,
                   HttpException,
                   NotAuthorizedException,
                   ConflictException,
                   BadRequestException,
                   NotFoundException

Parameters:: f -; listener -; throttle - - optional, can be used to slow down the transfer
Throws:: IOException; HttpException; NotAuthorizedException; ConflictException; BadRequestException; NotFoundException

uploadFile

public File uploadFile(File f)
                throws IOException,
                       HttpException,
                       NotAuthorizedException,
                       ConflictException,
                       BadRequestException,
                       NotFoundException

Throws:: IOException; HttpException; NotAuthorizedException; ConflictException; BadRequestException; NotFoundException

uploadFile

public File uploadFile(File f,
                       ProgressListener listener)
                throws FileNotFoundException,
                       IOException,
                       HttpException,
                       NotAuthorizedException,
                       ConflictException,
                       BadRequestException,
                       NotFoundException

Load a new file into this folder, and return a reference

Parameters:: f -; listener -
Returns:
Throws:: FileNotFoundException; IOException; HttpException; NotAuthorizedException; ConflictException; BadRequestException; NotFoundException

uploadFile

public File uploadFile(String newName,
                       File f,
                       ProgressListener listener)
                throws FileNotFoundException,
                       IOException,
                       HttpException,
                       NotAuthorizedException,
                       ConflictException,
                       BadRequestException,
                       NotFoundException

Upload a new file

Parameters:: newName -; f -; listener -
Returns:
Throws:: FileNotFoundException; IOException; HttpException; NotAuthorizedException; ConflictException; BadRequestException; NotFoundException

uploadFolder

protected void uploadFolder(File folder,
                            ProgressListener listener)
                     throws IOException,
                            HttpException,
                            NotAuthorizedException,
                            ConflictException,
                            BadRequestException,
                            NotFoundException

Throws:: IOException; HttpException; NotAuthorizedException; ConflictException; BadRequestException; NotFoundException

upload

public File upload(String name,
                   InputStream content,
                   Integer contentLength,
                   ProgressListener listener)
            throws IOException,
                   HttpException,
                   NotAuthorizedException,
                   ConflictException,
                   BadRequestException,
                   NotFoundException

Throws:: IOException; HttpException; NotAuthorizedException; ConflictException; BadRequestException; NotFoundException

upload

public File upload(String name,
                   InputStream content,
                   Long contentLength,
                   ProgressListener listener)
            throws IOException,
                   HttpException,
                   NotAuthorizedException,
                   ConflictException,
                   BadRequestException,
                   NotFoundException

Upload a new file

Parameters:: name -; content -; contentLength -; listener -
Returns:
Throws:: IOException; HttpException; NotAuthorizedException; ConflictException; BadRequestException; NotFoundException

upload

public File upload(String name,
                   InputStream content,
                   Long contentLength,
                   String contentType,
                   IfMatchCheck matchCheck,
                   ProgressListener listener)
            throws IOException,
                   HttpException,
                   NotAuthorizedException,
                   ConflictException,
                   BadRequestException,
                   NotFoundException

Parameters:: name -; content -; contentLength -; contentType -; etag - - the expected etag of the file being overwritten, or null if expecting to create new; listener -
Returns:
Throws:: IOException; HttpException; NotAuthorizedException; ConflictException; BadRequestException; NotFoundException

createFolder

public Folder createFolder(String name)
                    throws IOException,
                           HttpException,
                           NotAuthorizedException,
                           ConflictException,
                           BadRequestException,
                           NotFoundException

Throws:: IOException; HttpException; NotAuthorizedException; ConflictException; BadRequestException; NotFoundException

child

public Resource child(String childName)
               throws IOException,
                      HttpException,
                      NotAuthorizedException,
                      BadRequestException

Throws:: IOException; HttpException; NotAuthorizedException; BadRequestException

href
```
public String href()
```
Description copied from class: Resource

Returns the UN-encoded url

Overrides:

href in class Resource

Returns:

encodedUrl
```
public String encodedUrl()
```
Specified by:

encodedUrl in class Resource

Class Folder

Field Summary

Fields inherited from class io.milton.httpclient.Resource

Constructor Summary

Method Summary

Methods inherited from class io.milton.httpclient.Resource

Methods inherited from class java.lang.Object

Field Detail

cache

Constructor Detail

Folder

Folder

Method Detail

addListener

post

downloadTo

flush

hasChildren

numChildren

children

getChild

removeListener

toString

upload

upload

uploadFile

uploadFile

uploadFile

uploadFolder

upload

upload

upload

createFolder

child

href

encodedUrl