edu.wisc.ssec.mcidasv.startupmanager

Enum Platform

java.lang.Object

java.lang.Enum<Platform>

edu.wisc.ssec.mcidasv.startupmanager.Platform

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Platform>

public enum Platform
extends java.lang.Enum<Platform>

Represents platform specific details used by McIDAS-V. In particular, there are useful methods related to the McIDAS-V "userpath".

Currently McIDAS-V distinguishes between "Unix-like", macOS, and "Windows"; these can be accessed using Platform.UNIXLIKE, Platform.WINDOWS, or Platform.MAC.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAC macOS-specicfic platform information.
UNIXLIKE Instance of unix-specific platform information.
WINDOWS Instance of windows-specific platform information.

Field Summary

Fields

Modifier and Type	Field and Description
private int	availableMemory Total amount of memory avilable in megabytes
private java.lang.String	defaultPrefs Path to the preference file that ships with McIDAS-V.
private java.lang.String	newLine Holds the platform's representation of a new line.
private java.lang.String	userBundles Path to the bundles subdirectory within userDirectory.
private java.lang.String	userDirectory Path to the user's "userpath" directory.
private java.lang.String	userPrefs The path to the user's copy of the startup preferences.

Method Summary

Modifier and Type	Method and Description
int	getAvailableMemory() Returns the amount of available memory in megabytes.
java.lang.String	getDefaultPrefs() Returns the path of the startup preferences included in the McIDAS-V distribution.
java.lang.String	getNewLine() Returns the platform's notion of a new line.
java.lang.String	getUserBundles() Returns the path to the user's bundles directory.
java.lang.String	getUserDirectory() Returns the path to the user's "userpath" directory.
java.lang.String	getUserFile(java.lang.String filename) Returns the path to a file in the user's "userpath" directory.
java.lang.String	getUserPrefs() Returns the path of user's copy of the startup preferences.
void	setAvailableMemory(java.lang.String megabytes) Deprecated. There's not really a need for this method; the JVM can tell us the amount of memory.
void	setUserDirectory(java.lang.String path) Sets the path to the user's "userpath" directory explicitly.
java.lang.String	toString() Returns a brief summary of the platform specific file locations.
static Platform	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Platform[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNIXLIKE

public static final Platform UNIXLIKE

Instance of unix-specific platform information.

MAC

public static final Platform MAC

macOS-specicfic platform information.

WINDOWS

public static final Platform WINDOWS

Instance of windows-specific platform information.

Field Detail

userDirectory

private java.lang.String userDirectory

Path to the user's "userpath" directory.

userPrefs

private java.lang.String userPrefs

The path to the user's copy of the startup preferences.

defaultPrefs

private final java.lang.String defaultPrefs

Path to the preference file that ships with McIDAS-V.

newLine

private final java.lang.String newLine

Holds the platform's representation of a new line.

userBundles

private final java.lang.String userBundles

Path to the bundles subdirectory within userDirectory.

availableMemory

private int availableMemory

Total amount of memory avilable in megabytes

Method Detail

values

public static Platform[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Platform c : Platform.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Platform valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

setUserDirectory

public void setUserDirectory(java.lang.String path)
                      throws java.lang.IllegalArgumentException

Sets the path to the user's "userpath" directory explicitly. If the specified path does not yet exist, this method will first attempt to create it. The method will then attempt to verify whether or not McIDAS-V can use the path.

Parameters:

path - New path. Cannot be null, but does not have to exist prior to running this method. Be aware that this method will attempt to create path if it does not already exist.

Throws:

java.lang.IllegalArgumentException - if path is not a directory, or if it not both readable and writable.

setAvailableMemory

public void setAvailableMemory(java.lang.String megabytes)

Deprecated. There's not really a need for this method; the JVM can tell us the amount of memory.

Sets the amount of available memory. megabytes must be greater than or equal to zero.

Parameters:

megabytes - Memory in megabytes.

Throws:

java.lang.NullPointerException - if megabytes is null.

java.lang.IllegalArgumentException - if megabytes is less than zero or does not represent an integer.

See Also:

StartupManager.getArgs(boolean, boolean, java.lang.String[], java.util.Properties)

getUserDirectory

public java.lang.String getUserDirectory()

Returns the path to the user's "userpath" directory.

Returns:

Path to the user's directory.

getUserFile

public java.lang.String getUserFile(java.lang.String filename)

Returns the path to a file in the user's "userpath" directory.

Parameters:

filename - Filename within the userpath. Cannot be null, but does not need to be a filename that already exists within the userpath.

Returns:

Path to a file in the user's directory. Note: the file may not yet exist.

getUserBundles

public java.lang.String getUserBundles()

Returns the path to the user's bundles directory. Note: this should be a directory within getUserDirectory().

Returns:

Path to the user's bundles directory.

getAvailableMemory

public int getAvailableMemory()

Returns the amount of available memory in megabytes.

Returns:

Available memory in megabytes.

getUserPrefs

public java.lang.String getUserPrefs()

Returns the path of user's copy of the startup preferences.

Returns:

Path to the user's startup preferences file.

getDefaultPrefs

public java.lang.String getDefaultPrefs()

Returns the path of the startup preferences included in the McIDAS-V distribution. Mostly useful for normalizing the user directory.

Returns:

Path to the default startup preferences.

See Also:

OptionMaster.normalizeUserDirectory()

getNewLine

public java.lang.String getNewLine()

Returns the platform's notion of a new line.

Returns:

Unix-like: \n; Windows: \r\n.

toString

public java.lang.String toString()

Returns a brief summary of the platform specific file locations. Please note that the format and contents are subject to change.

Overrides:

toString in class java.lang.Enum<Platform>

Returns:

String that looks like [Platform@HASHCODE: defaultPrefs=..., userDirectory=..., userPrefs=...]