VMStartupParameters (beaTunes 5.2.24 API)

java.lang.Object
- com.tagtraum.core.VMStartupParameters

```
public class VMStartupParameters
extends Object
```
VMStartupParameters. Reads or replaces certain VM startup parameters for the next VM start.

Author:

Hendrik Schreiber

Constructor Summary

Constructors
Constructor	Description
`VMStartupParameters()`	Creates standard instance for beaTunes.
`VMStartupParameters(int minHeapMB, int maxHeapMB, int maxDirectMB, Preferences preferences, String windowsEnvironmentVariableName, Preferences macJVMOptions)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getMemoryConfiguration()`
`String`	`getMemoryDirectMax()`
`String`	`getMemoryHeapMax()`
`int`	`getMemoryHeapMaxInMegaBytes()`
`String`	`getMemoryHeapMin()`
`int`	`getMemoryHeapMinInMegaBytes()`
`boolean`	`matchesPreferences()`
`void`	`read()`	Read the memory settings that are set in this running JVM.
`void`	`setMemoryDirectMax(String memoryDirectMax)`
`void`	`setMemoryHeapMax(String memoryHeapMax)`
`void`	`setMemoryHeapMin(String memoryHeapMin)`
`String`	`toString()`
`void`	`write()`	Export the current values to either a Windows environment variable or macOS preferences.
`void`	`writePreferences()`
`void`	`writePreferencesToConfigFile()`

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

Constructor Detail
- VMStartupParameters
```
public VMStartupParameters(int minHeapMB,
                           int maxHeapMB,
                           int maxDirectMB,
                           Preferences preferences,
                           String windowsEnvironmentVariableName,
                           Preferences macJVMOptions)
```
  Parameters:
  
  minHeapMB - min heap memory in megabytes
  
  maxHeapMB - max heap memory in megabytes
  
  maxDirectMB - max direct memory in megabytes
  
  preferences - preferences to read and write values to/from
  
  windowsEnvironmentVariableName - environment variable for Windows, e.g. BEATUNES_MEMORY, to write to (may be honored by launcher)
  
  macJVMOptions - preferences object to store values in for macOS (may be honored by launcher)
- VMStartupParameters
```
public VMStartupParameters()
```
  Creates standard instance for beaTunes.

Method Detail

matchesPreferences

public boolean matchesPreferences()
                           throws IOException

Throws:: IOException

writePreferencesToConfigFile

public void writePreferencesToConfigFile()
                                  throws IOException

Throws:: IOException

writePreferences
```
public void writePreferences()
```

getMemoryHeapMax
```
public String getMemoryHeapMax()
```

getMemoryHeapMaxInMegaBytes

public int getMemoryHeapMaxInMegaBytes()

setMemoryHeapMax

public void setMemoryHeapMax(String memoryHeapMax)

getMemoryHeapMin
```
public String getMemoryHeapMin()
```

getMemoryHeapMinInMegaBytes

public int getMemoryHeapMinInMegaBytes()

setMemoryHeapMin

public void setMemoryHeapMin(String memoryHeapMin)

getMemoryDirectMax
```
public String getMemoryDirectMax()
```

setMemoryDirectMax

public void setMemoryDirectMax(String memoryDirectMax)

write
```
public void write()
           throws IOException
```
Export the current values to either a Windows environment variable or macOS preferences.

Throws:

IOException - if the export fails

read
```
public void read()
          throws IOException
```
Read the memory settings that are set in this running JVM.

Throws:

IOException - if we cannot read the current settings

getMemoryConfiguration

public String getMemoryConfiguration()

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

toString in class Object