Package org.terracotta.utilities.test.io

Enum WindowsSpecialFolder

java.lang.Object

java.lang.Enum<WindowsSpecialFolder>

org.terracotta.utilities.test.io.WindowsSpecialFolder

All Implemented Interfaces:

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

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

Provides the value for Windows Special Folder identifiers.

The values represented by this enumeration are determined when first referenced by calling PowerShell to obtain the path assigned to the special folder identifier.

See Also:

Environment.SpecialFolder Enum, Environment.GetFolderPath Method

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	WindowsSpecialFolder.LazyProperty<T>	A derived on first reference value holder.
static class	WindowsSpecialFolder.SpecialFolderException	Thrown when the folder assigned to a Windows Special Folder identifier cannot be determined.

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMMON_APPLICATION_DATA	Provides the Path corresponding to the CommonApplicationData special folder.
SYSTEM	Provides the Path corresponding to the System special folder.

Field Summary

Fields

Modifier and Type	Field	Description
private WindowsSpecialFolder.LazyProperty<java.nio.file.Path>	accessor
private static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Modifier	Constructor	Description
private	WindowsSpecialFolder(java.lang.String identifier, boolean create)

Method Summary

Modifier and Type	Method	Description
java.nio.file.Path	get()	Gets the Path assigned to the identified special folder.
private static java.nio.file.Path	getSpecialFolder(java.lang.String specialFolderId, boolean create)	Gets the Path to the identified Windows Special Folder.
static WindowsSpecialFolder	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static WindowsSpecialFolder[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COMMON_APPLICATION_DATA

public static final WindowsSpecialFolder COMMON_APPLICATION_DATA

Provides the Path corresponding to the CommonApplicationData special folder. A get via this constant will attempt to create the folder if it does not already exist.

SYSTEM

public static final WindowsSpecialFolder SYSTEM

Provides the Path corresponding to the System special folder.

Field Detail

accessor

private final WindowsSpecialFolder.LazyProperty<java.nio.file.Path> accessor

LOGGER

private static final org.slf4j.Logger LOGGER

Constructor Detail

WindowsSpecialFolder

private WindowsSpecialFolder(java.lang.String identifier,
                             boolean create)

Method Detail

values

public static WindowsSpecialFolder[] 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 (WindowsSpecialFolder c : WindowsSpecialFolder.values())
    System.out.println(c);

Returns:

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

valueOf

public static WindowsSpecialFolder 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

get

public java.nio.file.Path get()
                       throws java.io.IOException

Gets the Path assigned to the identified special folder.

Returns:

the special folder Path

Throws:

java.io.IOException - if an error is raised while attempting to determine the Path for the special folder

getSpecialFolder

private static java.nio.file.Path getSpecialFolder(java.lang.String specialFolderId,
                                                   boolean create)
                                            throws java.io.IOException

Gets the Path to the identified Windows Special Folder.

Parameters:

specialFolderId - the special folder identifier

create - if true, attempts to create the folder if it does not exist

Returns:

the path to the special folder; an empty path is returned if the folder does not exist

Throws:

java.io.IOException - if the special folder value cannot be determined