Package com.zerog.ia.auto.project

Class InstallFolder

java.lang.Object

com.zerog.ia.auto.project.ProjectObject

com.zerog.ia.auto.project.InstallFolder

All Implemented Interfaces:

DestinationFolder, Referenceable

public final class InstallFolder
extends ProjectObject
implements DestinationFolder

InstallFolder defines the main installation folder, where the application files are installed in the target machine. It can be customized to target different destination folders on each platform.

The InstallFolder object returned by the getInstallFolder() method in the Project class can be used as magic folder in the OSHostDestinationFolder class.

See Also:

Project.getInstallFolder()

Method Summary

Modifier and Type	Method	Description
int	getId()	The ID of the magic folder the InstallFolder represents.
DestinationFolder	getMacOSMagicFolder()	The magic folder where the InstallFolder should target on the Mac OS X platform.
java.lang.String	getMacOSSubFolder()	The sub folder where the InstallFolder should target on the Mac OS X platform.
DestinationFolder	getUnixMagicFolder()	The magic folder where the InstallFolder should target on the Unix platform.
java.lang.String	getUnixSubFolder()	The sub folder where the InstallFolder should target on the Unix platform.
DestinationFolder	getWindowsMagicFolder()	The magic folder where the InstallFolder should target on the Windows platform.
java.lang.String	getWindowsSubFolder()	The sub folder where the InstallFolder should target on the Windows platform.
void	setId(int Id)	The ID of the magic folder the InstallFolder represents.
void	setMacOSMagicFolder(DestinationFolder magicFolder)	The magic folder where the InstallFolder should target on the Mac OS X platform.
void	setMacOSSubFolder(java.lang.String folderName)	The sub folder where the InstallFolder should target on the Mac OS X platform.
void	setUnixMagicFolder(DestinationFolder magicFolder)	The magic folder where the InstallFolder should target on the Unix platform.
void	setUnixSubFolder(java.lang.String folderName)	The sub folder where the InstallFolder should target on the Unix platform.
void	setWindowsMagicFolder(DestinationFolder magicFolder)	The magic folder where the InstallFolder should target on the Windows platform.
void	setWindowsSubFolder(java.lang.String folderName)	The sub folder where the InstallFolder should target on the Windows platform.

Methods inherited from class com.zerog.ia.auto.project.ProjectObject

equals, getReferenceID, hashCode, setReferenceID

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

setUnixMagicFolder

public void setUnixMagicFolder(DestinationFolder magicFolder)

The magic folder where the InstallFolder should target on the Unix platform. Default to PROGRAMS_FOLDER.

See Also:

MagicFolder

setMacOSMagicFolder

public void setMacOSMagicFolder(DestinationFolder magicFolder)

The magic folder where the InstallFolder should target on the Mac OS X platform. Default to PROGRAMS_FOLDER.

See Also:

MagicFolder

setWindowsMagicFolder

public void setWindowsMagicFolder(DestinationFolder magicFolder)

The magic folder where the InstallFolder should target on the Windows platform. Default to PROGRAMS_FOLDER.

See Also:

MagicFolder

setUnixSubFolder

public void setUnixSubFolder(java.lang.String folderName)

The sub folder where the InstallFolder should target on the Unix platform. The sub folder is relative to the unixMagicFolder. Default to "$PRODUCT_NAME$".

See Also:

setUnixMagicFolder(com.zerog.ia.auto.project.DestinationFolder)

setMacOSSubFolder

public void setMacOSSubFolder(java.lang.String folderName)

The sub folder where the InstallFolder should target on the Mac OS X platform. The sub folder is relative to the macOSMagicFolder. Default to "$PRODUCT_NAME$".

See Also:

setMacOSMagicFolder(com.zerog.ia.auto.project.DestinationFolder)

setWindowsSubFolder

public void setWindowsSubFolder(java.lang.String folderName)

The sub folder where the InstallFolder should target on the Windows platform. The sub folder is relative to the windowsMagicFolder. Default to "$PRODUCT_NAME$".

See Also:

setWindowsMagicFolder(com.zerog.ia.auto.project.DestinationFolder)

getUnixMagicFolder

public DestinationFolder getUnixMagicFolder()

The magic folder where the InstallFolder should target on the Unix platform. Default to PROGRAMS_FOLDER.

See Also:

MagicFolder

getMacOSMagicFolder

public DestinationFolder getMacOSMagicFolder()

The magic folder where the InstallFolder should target on the Mac OS X platform. Default to PROGRAMS_FOLDER.

See Also:

MagicFolder

getWindowsMagicFolder

public DestinationFolder getWindowsMagicFolder()

The magic folder where the InstallFolder should target on the Windows platform. Default to PROGRAMS_FOLDER.

See Also:

MagicFolder

getUnixSubFolder

public java.lang.String getUnixSubFolder()

The sub folder where the InstallFolder should target on the Unix platform. The sub folder is relative to the unixMagicFolder. Default to "$PRODUCT_NAME$".

getMacOSSubFolder

public java.lang.String getMacOSSubFolder()

The sub folder where the InstallFolder should target on the Mac OS X platform. The sub folder is relative to the macOSMagicFolder. Default to "$PRODUCT_NAME$".

getWindowsSubFolder

public java.lang.String getWindowsSubFolder()

The sub folder where the InstallFolder should target on the Windows platform. The sub folder is relative to the windowsMagicFolder. Default to "$PRODUCT_NAME$".

getId

public int getId()

The ID of the magic folder the InstallFolder represents.

Specified by:

getId in interface DestinationFolder

setId

public void setId(int Id)

The ID of the magic folder the InstallFolder represents.