RecentFilesManager (IQM 3.5 API)

java.lang.Object
- at.mug.iqm.recentfiles.RecentFilesManager

```
public class RecentFilesManager
extends Object
```
This class manages the recently opened files of IQM. Properties of each file are kept in an XML file.

Since:

3.1

Author:

Philipp Kainz

Field Summary

Fields
Modifier and Type	Field and Description
`private static RecentFilesManager`	`currentManager`
`private String`	`fileName`
`private JAXBContext`	`jaxbContext`
`private static org.apache.log4j.Logger`	`logger`
`private Marshaller`	`marshaller`
`private ObjectFactory`	`of`
`private File`	`path`
`private RecentFiles`	`recentFiles`
`private Unmarshaller`	`unmarshaller`
`private File`	`xmlFile`
`private InputStream`	`xmlSchemaFileIS`
`private String`	`xmlSchemaLocation`

Constructor Summary

Constructors
Constructor and Description

RecentFilesManager()
The constructor.

Constructors
Constructor and Description
`RecentFilesManager()` The constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNewRecentFile(File f, DataType dataType, int maxItems)` This method adds a recently opened file to the top of the existing ones.
`void`	`clearRecentFiles()` This method erases the list of latest files.
`private File`	`exist(File jaxbFile)` Search for an existing file in the list.
`static RecentFilesManager`	`getCurrentInstance()`
`RecentFiles`	`getRecentFiles()` Gets the recent file list.
`static void`	`main(String[] args)`
`void`	`read()` Public delegate method for reading the xml file.
`protected void`	`readXML()` Loads the list of recent files from an existing XML file.
`private static void`	`setCurrentInstance(RecentFilesManager arg)`
`private void`	`setLastUpdate()` Each time the configuration is updated, write the time stamp too.
`private void`	`validate()` Validates the XML file against the defined schema.
`protected void`	`writeInitialXML(RecentFiles empty)` Writes an initial XML file to the specified path in the file system.
`protected void`	`writeXML()` Writes an XML file to the specified path in the file system.

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

- Field Detail
  - logger
```
private static final org.apache.log4j.Logger logger
```
  - currentManager
```
private static RecentFilesManager currentManager
```
  - path
```
private File path
```
  - fileName
```
private String fileName
```
  - xmlSchemaLocation
```
private final String xmlSchemaLocation
```
    See Also:
    
    Constant Field Values
  - xmlFile
```
private File xmlFile
```
  - xmlSchemaFileIS
```
private InputStream xmlSchemaFileIS
```
  - jaxbContext
```
private JAXBContext jaxbContext
```
  - marshaller
```
private Marshaller marshaller
```
  - unmarshaller
```
private Unmarshaller unmarshaller
```
  - recentFiles
```
private RecentFiles recentFiles
```
  - of
```
private ObjectFactory of
```
- Constructor Detail
  - RecentFilesManager
```
public RecentFilesManager()
```
    The constructor.
- Method Detail
  - addNewRecentFile
```
public void addNewRecentFile(File f,
                             DataType dataType,
                             int maxItems)
                      throws Exception
```
    This method adds a recently opened file to the top of the existing ones. Files are ordered by access/modification date.
    
    Parameters:
    
    f - the file
    
    dataType - DataType of the file
    
    maxItems - maximum number of items to keep
    
    Throws:
    
    Exception
  - exist
```
private File exist(File jaxbFile)
```
    Search for an existing file in the list.
    
    Parameters:
    
    jaxbFile -
    
    Returns:
    
    a File object
  - clearRecentFiles
```
public void clearRecentFiles()
                      throws Exception
```
    This method erases the list of latest files.
    
    Throws:
    
    Exception
  - getRecentFiles
```
public RecentFiles getRecentFiles()
```
    Gets the recent file list.
    
    Returns:
    
    the Java object of the file
  - validate
```
private void validate()
```
    Validates the XML file against the defined schema.
  - read
```
public void read()
          throws JAXBException
```
    Public delegate method for reading the xml file.
    
    Throws:
    
    JAXBException
  - readXML
```
protected void readXML()
                throws JAXBException
```
    Loads the list of recent files from an existing XML file. The file is validated against the corresponding XML schema before loading.
    
    Throws:
    
    JAXBException - - if the XML file does not comply with the schema
  - writeXML
```
protected void writeXML()
```
    Writes an XML file to the specified path in the file system.
  - writeInitialXML
```
protected void writeInitialXML(RecentFiles empty)
```
    Writes an initial XML file to the specified path in the file system.
  - setLastUpdate
```
private void setLastUpdate()
```
    Each time the configuration is updated, write the time stamp too.
  - getCurrentInstance
```
public static RecentFilesManager getCurrentInstance()
```
  - setCurrentInstance
```
private static void setCurrentInstance(RecentFilesManager arg)
```
  - main
```
public static void main(String[] args)
```

Class RecentFilesManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

currentManager

path

fileName

xmlSchemaLocation

xmlFile

xmlSchemaFileIS

jaxbContext

marshaller

unmarshaller

recentFiles

of

Constructor Detail

RecentFilesManager

Method Detail

addNewRecentFile

exist

clearRecentFiles

getRecentFiles

validate

read

readXML

writeXML

writeInitialXML

setLastUpdate

getCurrentInstance

setCurrentInstance

main