Package com.zerog.ia.auto.project

Enum MagicFolder

  • All Implemented Interfaces:
    DestinationFolder, Referenceable, java.io.Serializable, java.lang.Comparable<MagicFolder>
    public enum MagicFolder
extends java.lang.Enum<MagicFolder>
implements Referenceable, DestinationFolder
    Magic Folders represent a specific location, such as the user selected installation directory, the desktop, or the location for library files. At install time, the installer determines which operating system it is running on, and sets the magic folders to the correct absolute paths.

    Many Magic Folders are platform specific and many are predefined by InstallAnywhere to standard locations across InstallAnywhere supported platforms.

    • Enum Constant Detail

      • PROGRAMS_FOLDER

        public static final MagicFolder PROGRAMS_FOLDER
        The default application directory on the destination system. (Program Files on Windows, in the Applications folder on Mac OS X, and the logged-in-end-user's home account on Unix.)

      • PROGRAMS_FOLDER_64BITS

        public static final MagicFolder PROGRAMS_FOLDER_64BITS
        The default 64-bit application directory on a 64-bit system.

      • PROGRAMS_FOLDER_32BITS

        public static final MagicFolder PROGRAMS_FOLDER_32BITS
        The default 32-bit application directory on a system.

      • SYSTEM_FOLDER

        public static final MagicFolder SYSTEM_FOLDER
        The System folder on the target machine.

      • SYSTEM_FOLDER_64BITS

        public static final MagicFolder SYSTEM_FOLDER_64BITS
        The default 64-bit System folder on a 64-bit system.

      • SYSTEM_FOLDER_32BITS

        public static final MagicFolder SYSTEM_FOLDER_32BITS
        The default 32-bit System folder on a system.

      • DESKTOP_FOLDER

        public static final MagicFolder DESKTOP_FOLDER
        The desktop on the target machine. This folder only resolves on Windows, Linux, and Mac systems.

      • STARTUP_FOLDER

        public static final MagicFolder STARTUP_FOLDER
        The automatic startup folder for items that are launched automatically during operating system boot up. This folder only resolves on Windows systems.

      • INSTALL_DRIVE_ROOT

        public static final MagicFolder INSTALL_DRIVE_ROOT
        The root directory on the volume where the installation is taking place.

      • SYSTEM_DRIVE_ROOT

        public static final MagicFolder SYSTEM_DRIVE_ROOT
        The root directory of the system drive.

      • JAVA_HOME

        public static final MagicFolder JAVA_HOME
        The home directory of the Java Virtual Machine to be used.

      • FONTS_DIRECTORY

        public static final MagicFolder FONTS_DIRECTORY
        The Fonts directory on Windows computers.

      • TEMP_DIRECTORY

        public static final MagicFolder TEMP_DIRECTORY
        The temp directory on the target machine. When running the pure Java installer on Windows, $TEMP_DIR$ will resolve the user's home directory.

      • INSTALLER_TEMP_DIRECTORY

        public static final MagicFolder INSTALLER_TEMP_DIRECTORY
        The temp directory for use by the installer. This is deleted when the installation is complete, assuming no items are in use.

      • WINDOWS_DIRECTORY

        public static final MagicFolder WINDOWS_DIRECTORY
        The Windows directory on Windows computers.

      • WINDOWS_START_MENU

        public static final MagicFolder WINDOWS_START_MENU
        The Start menu directory on Windows computers.

      • WINDOWS_PROGRAMS_MENU

        public static final MagicFolder WINDOWS_PROGRAMS_MENU
        The Programs menu (in the Start menu) on Windows systems.

      • WINDOWS_ALL_USERS_START_MENU

        public static final MagicFolder WINDOWS_ALL_USERS_START_MENU
        The All Users Start menu directory for Windows computers.

      • WINDOWS_ALL_USERS_PROGRAM_MENU

        public static final MagicFolder WINDOWS_ALL_USERS_PROGRAM_MENU
        The All Users Programs menu (in the Start menu) directory for Windows computers.

      • WINDOWS_ALL_USERS_STARTUP

        public static final MagicFolder WINDOWS_ALL_USERS_STARTUP
        The All Users Startup folder (in the Start menu) on Windows computers.

      • WINDOWS_ALL_USERS_DESKTOP

        public static final MagicFolder WINDOWS_ALL_USERS_DESKTOP
        The Windows Common Desktop folder on Windows computers.

      • WINDOWS_QUICK_LAUNCH

        public static final MagicFolder WINDOWS_QUICK_LAUNCH
        The Quick Launch Bar on Windows. On Windows 2000 or newer, the location is relative to the UserProfile environment variable.

      • MACOS_DOCK

        public static final MagicFolder MACOS_DOCK
        The Mac OS X Dock (for Shortcuts only). Other types of files cannot be installed to the Dock.

      • MACOS_USER_APPLICATIONS

        public static final MagicFolder MACOS_USER_APPLICATIONS
        The User Applications directory of the end user running the installer (Mac OS X only).

      • MACOS_CLEANUP_AT_STARTUP

        public static final MagicFolder MACOS_CLEANUP_AT_STARTUP
        The clean-up at statup folder (Mac OS X only).

      • MACOS_PREFERENCES_FOLDER

        public static final MagicFolder MACOS_PREFERENCES_FOLDER
        The user preferences folder (Mac OS X only)

      • UNIX_USR_HOME_DIR

        public static final MagicFolder UNIX_USR_HOME_DIR
        The user home directory.

      • UNIX_USR_LOCAL_BIN_DIR

        public static final MagicFolder UNIX_USR_LOCAL_BIN_DIR
        The /usr/local/bin directory (Unix computers only).

      • UNIX_OPT_DIR

        public static final MagicFolder UNIX_OPT_DIR
        The /opt directory (UNIX computers only).

      • UNIX_USER_BIN_DIR

        public static final MagicFolder UNIX_USER_BIN_DIR
        The /usr/bin directory (Unix computers only).

      • DO_NOT_INSTALL

        public static final MagicFolder DO_NOT_INSTALL
        A special Magic Folder for installer files that are not needed on the target platform. $DO_NOT_INSTALL$ is most commonly applied to files (typically localized license agreements and graphics) that are used during installation but need not remain on the target system.

      • USER_MAGIC_FOLDER_1

        public static final MagicFolder USER_MAGIC_FOLDER_1
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_2

        public static final MagicFolder USER_MAGIC_FOLDER_2
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_3

        public static final MagicFolder USER_MAGIC_FOLDER_3
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_4

        public static final MagicFolder USER_MAGIC_FOLDER_4
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_5

        public static final MagicFolder USER_MAGIC_FOLDER_5
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_6

        public static final MagicFolder USER_MAGIC_FOLDER_6
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_7

        public static final MagicFolder USER_MAGIC_FOLDER_7
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_8

        public static final MagicFolder USER_MAGIC_FOLDER_8
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_9

        public static final MagicFolder USER_MAGIC_FOLDER_9
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_10

        public static final MagicFolder USER_MAGIC_FOLDER_10
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_11

        public static final MagicFolder USER_MAGIC_FOLDER_11
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_12

        public static final MagicFolder USER_MAGIC_FOLDER_12
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_13

        public static final MagicFolder USER_MAGIC_FOLDER_13
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_14

        public static final MagicFolder USER_MAGIC_FOLDER_14
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_15

        public static final MagicFolder USER_MAGIC_FOLDER_15
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_16

        public static final MagicFolder USER_MAGIC_FOLDER_16
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_17

        public static final MagicFolder USER_MAGIC_FOLDER_17
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_18

        public static final MagicFolder USER_MAGIC_FOLDER_18
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_19

        public static final MagicFolder USER_MAGIC_FOLDER_19
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_20

        public static final MagicFolder USER_MAGIC_FOLDER_20
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_21

        public static final MagicFolder USER_MAGIC_FOLDER_21
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_22

        public static final MagicFolder USER_MAGIC_FOLDER_22
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_23

        public static final MagicFolder USER_MAGIC_FOLDER_23
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_24

        public static final MagicFolder USER_MAGIC_FOLDER_24
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

      • USER_MAGIC_FOLDER_25

        public static final MagicFolder USER_MAGIC_FOLDER_25
        A user-defined install-destination Magic Folders. It installs to whichever directory the variable name has been set. To set the variable, use one of the set InstallAnywhere variable actions.

    • Method Detail

      • values

        public static MagicFolder[] 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 (MagicFolder c : MagicFolder.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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

      • getId

        public int getId()
        The magic folder identifier.
        Specified by:
        getId in interface DestinationFolder

      • getReferenceID

        public java.lang.String getReferenceID()
        The magic folder object unique identifier.
        Specified by:
        getReferenceID in interface Referenceable

      • setReferenceID

        public void setReferenceID​(java.lang.String id)
        The magic folder object unique identifier. This method is not intended to be called by the API's end user.
        Specified by:
        setReferenceID in interface Referenceable

      • get

        public static MagicFolder get​(int id)
        Returns a MagicFolder based on its identifier.

      • toString

        public java.lang.String toString()
        The magic folder identifier.
        Overrides:
        toString in class java.lang.Enum<MagicFolder>