TargetFactory (IzPack util module 5.2.4 API)

java.lang.Object
- com.izforge.izpack.util.TargetFactory

```
public class TargetFactory
extends Object
```
The TargetFactory serves as a central mechanism to instantiate OS specific class flavors, provide OS specific file extension types, default install directories and similar functionality. In addition it provides services that are related to OS versions and flavors. For a tutorial on using some of the features in this class see the TargetFactory Tutorial.

Version:

0.0.1 / 1/3/2002

Author:

Elmar Grom

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`GENERIC` Used to report a non specific operating system.
`static int`	`NT` Used to identify the Windows-NT class of operating systems in terms of an OS flavor.
`static int`	`OTHER` Nonspecific processor architecture, other than X86.
`static int`	`STANDARD` This is the basic flavor for every operating system.
`static int`	`UNIX` Identifies generic UNIX operating systems
`static int`	`WINDOWS` Identifies Microsoft Windows.
`static int`	`X` Used to identify the OS X flavor of the Mac OS
`static int`	`X86` Identifies Intel X86 based processor types.

Constructor Summary

Constructors
Constructor and Description

TargetFactory(TargetPlatformFactory factory)
Constructs a TargetFactory.

Constructors
Constructor and Description
`TargetFactory(TargetPlatformFactory factory)` Constructs a `TargetFactory`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getArchitecture()` Returns an index number that identified the processor architecture of the target system.
`static String`	`getCurrentOSPrefix()` Gets a prefix alias for the current platform.
`String`	`getDefaultInstallPath(String appName)` Returns the system dependent default install path.
`String`	`getNativeLibraryExtension()` Returns the file extension customarily used on the target OS for dynamically loadable libraries.
`int`	`getOS()` Returns the index number for the target operating system that was detected.
`int`	`getOSFlavor()` Returns the index number for the operating system flavor that was detected on the target system.
`<T> T`	`makeObject(Class<T> clazz)` This method returns an OS specific instance of the requested class.
`Object`	`makeObject(String name)` This method returns an OS and OS flavor specific instance of the requested class.
`boolean`	`versionIsHigher(String version)` Returns true if the version in the parameter string is higher than the version of the target os.

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

- Field Detail
  - WINDOWS
```
public static final int WINDOWS
```
    Identifies Microsoft Windows.
    
    See Also:
    
    Constant Field Values
  - UNIX
```
public static final int UNIX
```
    Identifies generic UNIX operating systems
    
    See Also:
    
    Constant Field Values
  - GENERIC
```
public static final int GENERIC
```
    Used to report a non specific operating system.
    
    See Also:
    
    Constant Field Values
  - STANDARD
```
public static final int STANDARD
```
    This is the basic flavor for every operating system.
    
    See Also:
    
    Constant Field Values
  - NT
```
public static final int NT
```
    Used to identify the Windows-NT class of operating systems in terms of an OS flavor. It is reported for Windows-NT, 2000 and XP.
    
    See Also:
    
    Constant Field Values
  - X
```
public static final int X
```
    Used to identify the OS X flavor of the Mac OS
    
    See Also:
    
    Constant Field Values
  - X86
```
public static final int X86
```
    Identifies Intel X86 based processor types.
    
    See Also:
    
    Constant Field Values
  - OTHER
```
public static final int OTHER
```
    Nonspecific processor architecture, other than X86.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TargetFactory
```
public TargetFactory(TargetPlatformFactory factory)
```
    Constructs a TargetFactory.
    
    Parameters:
    
    factory - the factory to delegate to
- Method Detail
  - makeObject
```
public <T> T makeObject(Class<T> clazz)
                 throws Exception
```
    This method returns an OS specific instance of the requested class.
    This implementation delegates to DefaultTargetPlatformFactory, falling back to makeObject(String) if the call fails.
    
    Parameters:
    
    clazz - the
    
    Returns:
    
    an OS specific instance of clazz
    
    Throws:
    
    Exception - for any error
  - makeObject
```
public Object makeObject(String name)
                  throws Exception
```
    This method returns an OS and OS flavor specific instance of the requested class.
    
    Class Naming Rules
    Class versions must be named with the OS and OS flavor as prefix. The prefixes are simply concatenated, with the OS prefix first and the flavor prefix second. Use the following OS specific prefixes:
    
    Operating System Prefix
    
    Microsoft Windows Win_
    
    Mac OS Mac_
    
    UNIX UNIX_
    
    For the different OS flavors, use these prefixes:
    
    OS Flavor Prefix
    
    NT NT_
    
    Mac OS X X_
    
    Naming Example:
    
    For the class MyClass, the specific version for Windows NT must be in the same package as MyClass and the name must be Win_NT_MyClass. A version that should be instantiated for any non-NT flavor would be called Win_MyClass. This would also be the version instantiated on Windows NT if the version Win_NT_MyClass does not exist.
    
    The Loading Process
    
    The process is completed after the first successful attempt to load a class.
    1. load a version that is OS and OS-Flavor specific
    2. load a version that is OS specific
    3. load the base version (without OS or OS-Flavor prefix)
    See the TargetFactory Tutorial for more information.
    Parameters:
    
    name - the fully qualified name of the class to load without the extension.
    
    Returns:
    
    An instance of the requested class. Note that specific initialization that can not be accomplished in the default constructor still needs to be performed before the object can be used.
    
    Throws:
    
    Exception - if all attempts to instantiate class fail
  - versionIsHigher
```
public boolean versionIsHigher(String version)
                        throws Exception
```
    Returns true if the version in the parameter string is higher than the version of the target os.
    
    Parameters:
    
    version - the version number to compare to
    
    Returns:
    
    false if the version of the target system is higher, otherwise true
    
    Throws:
    
    Exception
  - getOS
```
public int getOS()
```
    Returns the index number for the target operating system that was detected.
    
    Returns:
    
    an index number for the OS
    
    See Also:
    
    WINDOWS, UNIX, GENERIC
  - getOSFlavor
```
public int getOSFlavor()
```
    Returns the index number for the operating system flavor that was detected on the target system.
    
    Returns:
    
    an index for the OS flavor
    
    See Also:
    
    STANDARD, NT, X
  - getArchitecture
```
public int getArchitecture()
```
    Returns an index number that identified the processor architecture of the target system.
    
    Returns:
    
    an index for the processor architecture
    
    See Also:
    
    X86, OTHER
  - getNativeLibraryExtension
```
public String getNativeLibraryExtension()
```
    Returns the file extension customarily used on the target OS for dynamically loadable libraries.
    
    Returns:
    
    a String containing the customary library extension for the target OS. Note that the string might be empty if there no such specific extension for the target OS.
  - getDefaultInstallPath
```
public String getDefaultInstallPath(String appName)
```
    Returns the system dependent default install path. This is typically used to suggest an istall path to the end user, when performing an installation. The default install path is assembled form the OS specific path fragment specified in INSTALL_PATH_FRAGMENT, possibly a drive letter and the application name. The user the option to define resources that define default paths which differ from the path fragments defined here. The following resource names will be recognized by this method:
    - TargetPanel.dir.windows
    - TargetPanel.dir.macosx
    - TargetPanel.dir.unix
    - TargetPanel.dir plus the all lower case version of System.getProperty ("os.name"), with all spaces replaced by an underscore ('_').
    - TargetPanel.dir
    Parameters:
    
    appName - the name of the application to install. If no specific resource has been set, then this name will be appended to the OS specific default path fragment.
    
    Returns:
    
    the default install path for the target system
  - getCurrentOSPrefix
```
public static String getCurrentOSPrefix()
```
    Gets a prefix alias for the current platform. "Win_" on domestic Windows Systems (Windows XP and 7, etc.), "Win_NT_" on WinNT4 and 2000, Mac on Mac Mac_X on macosx and Unix_
    
    Returns:
    
    a prefix alias for the current platform

Operating System	Prefix
Microsoft Windows	Win_
Mac OS	Mac_
UNIX	UNIX_

OS Flavor	Prefix
NT	NT_
Mac OS X	X_

Class TargetFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WINDOWS

UNIX

GENERIC

STANDARD

NT

X

X86

OTHER

Constructor Detail

TargetFactory

Method Detail

makeObject

makeObject

versionIsHigher

getOS

getOSFlavor

getArchitecture

getNativeLibraryExtension

getDefaultInstallPath

getCurrentOSPrefix