PortFileManager (pentaho-platform-extensions 9.3.0.0-424 API)

java.lang.Object
- org.pentaho.platform.settings.PortFileManager

```
public class PortFileManager
extends Object
```
PortFileManager is a singleton that saves the ports in use and creates a file with a ports list when requested.

Author:

Joao L. M. Pereira

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`addPort(Integer port)`	Add a new used port
`void`	`clear()`	Used for testing, simulates a new JVM
`static PortFileManager`	`getInstance()`	Returns the PortFileManager instance, if it does not exists, creates a new one
`boolean`	`removePort(Integer port)`	Removes a used port
`void`	`writeUsedPortFile(String filePath)`	Writes a port list delimited by comma into a specified file

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

- Method Detail
  - getInstance
```
public static PortFileManager getInstance()
```
    Returns the PortFileManager instance, if it does not exists, creates a new one
    
    Returns:
    
    the PortFileManager instance, it is a singleton
  - addPort
```
public boolean addPort(Integer port)
```
    Add a new used port
    
    Parameters:
    
    port - a port being used
    
    Returns:
    
    true, if the port did not exist before
  - removePort
```
public boolean removePort(Integer port)
```
    Removes a used port
    
    Parameters:
    
    port - a port that was used, not anymore
    
    Returns:
    
    true, if the port exist before
  - writeUsedPortFile
```
public void writeUsedPortFile(String filePath)
                       throws FileNotFoundException,
                              IOException
```
    Writes a port list delimited by comma into a specified file
    
    Parameters:
    
    filePath - Path for the file to be written
    
    Throws:
    
    FileNotFoundException
    
    IOException
  - clear
```
public void clear()
```
    Used for testing, simulates a new JVM