ERXFileContext (Project Wonder Reference Documentation)

java.lang.Object
- er.extensions.foundation.ERXFileContext

```
public class ERXFileContext
extends Object
```
A class to encapsulate a file reference and related information in the context of web application usage. Very commonly, you want a user friendly name for a download file or you want to grab the filename of a file that the client uploaded, yet you might have the file data streamed to or from a temporary file with a long meaningless unique name in temp directory. This class just makes it convenient to have a real file, a client upload or download filename and a mimetype bundled together in one class. Useful for custom components that wrap FileUpload allowing you to bind a single ERXFileContext instead of 3 bindings. You can bind the attributes of this class to any of the standard file upload WOComponent bindings that match the 3 attributes encapsulated by this class. Useful for passing around file download information as a single object rather than fiddling with 3 pieces of information.

Author:

kieran

Constructor Summary

Constructors
Constructor and Description
`ERXFileContext()`
`ERXFileContext(File file)`
`ERXFileContext(File file, String clientFileName, String mimeType)`
`ERXFileContext(String path)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`clientFileName()`
`String`	`extension()` Returns the extension for the file represented by the receiver.
`File`	`file()`
`String`	`mimeType()`
`String`	`path()`
`void`	`reset()`
`void`	`setClientFileName(String clientFileName)`
`void`	`setFile(File file)`
`void`	`setMimeType(String mimeType)`
`void`	`setPath(String path)`
`String`	`toString()`

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

- Constructor Detail
  - ERXFileContext
```
public ERXFileContext()
```
  - ERXFileContext
```
public ERXFileContext(File file)
```
  - ERXFileContext
```
public ERXFileContext(File file,
                      String clientFileName,
                      String mimeType)
```
  - ERXFileContext
```
public ERXFileContext(String path)
```
- Method Detail
  - reset
```
public void reset()
```
  - file
```
public File file()
```
    Returns:
    
    the File
  - setFile
```
public void setFile(File file)
```
    Parameters:
    
    file -
  - path
```
public String path()
```
    Returns:
    
    the absolute pathname of the file
  - setPath
```
public void setPath(String path)
```
    Parameters:
    
    path - the absolute pathname of the file
  - clientFileName
```
public String clientFileName()
```
    Returns:
    
    the file name from the perspective of the client or user, for example the original name of a file that was uploaded, or the name we are assigning to a file to be downloaded which may be different to the temporary and/or unique name that we assign in the file system.
  - setClientFileName
```
public void setClientFileName(String clientFileName)
```
    Parameters:
    
    clientFileName -
  - mimeType
```
public String mimeType()
```
    Returns:
    
    the File mime-type
  - setMimeType
```
public void setMimeType(String mimeType)
```
    Parameters:
    
    mimeType - the File mime-type
  - extension
```
public String extension()
```
    Returns the extension for the file represented by the receiver.
    
    Returns:
    
    the extension of the filename (or null)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ERXFileContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ERXFileContext

ERXFileContext

ERXFileContext

ERXFileContext

Method Detail

reset

file

setFile

path

setPath

clientFileName

setClientFileName

mimeType

setMimeType

extension

toString