Class Os
java.lang.Object
org.apache.tools.ant.taskdefs.condition.Os
- All Implemented Interfaces:
Condition
public class Os extends java.lang.Object implements Condition
Condition that tests the OS type.
- Since:
- Ant 1.4
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringFAMILY_9XOS family that can be tested for.static java.lang.StringFAMILY_DOSOS family that can be tested for.static java.lang.StringFAMILY_MACOS family that can be tested for.static java.lang.StringFAMILY_NETWAREOS family that can be tested for.static java.lang.StringFAMILY_NTOS family that can be tested for.static java.lang.StringFAMILY_OS2OS family that can be tested for.static java.lang.StringFAMILY_OS400OS family that can be tested for.static java.lang.StringFAMILY_TANDEMOS family that can be tested for.static java.lang.StringFAMILY_UNIXOS family that can be tested for.static java.lang.StringFAMILY_VMSOS family that can be tested for.static java.lang.StringFAMILY_WINDOWSOS family that can be tested for.static java.lang.StringFAMILY_ZOSOS family that can be tested for. -
Constructor Summary
-
Method Summary
Modifier and Type Method Description booleaneval()Determines if the OS on which Ant is executing matches the type of that set in setFamily.static booleanisArch(java.lang.String arch)Determines if the OS on which Ant is executing matches the given OS architecture.static booleanisFamily(java.lang.String family)Determines if the OS on which Ant is executing matches the given OS family.static booleanisName(java.lang.String name)Determines if the OS on which Ant is executing matches the given OS name.static booleanisOs(java.lang.String family, java.lang.String name, java.lang.String arch, java.lang.String version)Determines if the OS on which Ant is executing matches the given OS family, name, architecture and versionstatic booleanisVersion(java.lang.String version)Determines if the OS on which Ant is executing matches the given OS version.voidsetArch(java.lang.String arch)Sets the desired OS architecturevoidsetFamily(java.lang.String f)Sets the desired OS family typevoidsetName(java.lang.String name)Sets the desired OS namevoidsetVersion(java.lang.String version)Sets the desired OS version
-
Field Details
-
FAMILY_WINDOWS
public static final java.lang.String FAMILY_WINDOWSOS family that can be tested for. "windows"- See Also:
- Constant Field Values
-
FAMILY_9X
public static final java.lang.String FAMILY_9XOS family that can be tested for. "win9x"- See Also:
- Constant Field Values
-
FAMILY_NT
public static final java.lang.String FAMILY_NTOS family that can be tested for. "winnt"- See Also:
- Constant Field Values
-
FAMILY_OS2
public static final java.lang.String FAMILY_OS2OS family that can be tested for. "os/2"- See Also:
- Constant Field Values
-
FAMILY_NETWARE
public static final java.lang.String FAMILY_NETWAREOS family that can be tested for. "netware"- See Also:
- Constant Field Values
-
FAMILY_DOS
public static final java.lang.String FAMILY_DOSOS family that can be tested for. "dos"- See Also:
- Constant Field Values
-
FAMILY_MAC
public static final java.lang.String FAMILY_MACOS family that can be tested for. "mac"- See Also:
- Constant Field Values
-
FAMILY_TANDEM
public static final java.lang.String FAMILY_TANDEMOS family that can be tested for. "tandem"- See Also:
- Constant Field Values
-
FAMILY_UNIX
public static final java.lang.String FAMILY_UNIXOS family that can be tested for. "unix"- See Also:
- Constant Field Values
-
FAMILY_VMS
public static final java.lang.String FAMILY_VMSOS family that can be tested for. "openvms"- See Also:
- Constant Field Values
-
FAMILY_ZOS
public static final java.lang.String FAMILY_ZOSOS family that can be tested for. "z/os"- See Also:
- Constant Field Values
-
FAMILY_OS400
public static final java.lang.String FAMILY_OS400OS family that can be tested for. "os/400"- See Also:
- Constant Field Values
-
-
Constructor Details
-
Method Details
-
setFamily
public void setFamily(java.lang.String f)Sets the desired OS family type- Parameters:
f- The OS family type desiredPossible values:
- dos
- mac
- netware
- os/2
- tandem
- unix
- windows
- win9x
- z/os
- os/400
-
setName
public void setName(java.lang.String name)Sets the desired OS name- Parameters:
name- The OS name
-
setArch
public void setArch(java.lang.String arch)Sets the desired OS architecture- Parameters:
arch- The OS architecture
-
setVersion
public void setVersion(java.lang.String version)Sets the desired OS version- Parameters:
version- The OS version
-
eval
Determines if the OS on which Ant is executing matches the type of that set in setFamily.- Specified by:
evalin interfaceCondition- Returns:
- true if the os matches.
- Throws:
BuildException- if there is an error.- See Also:
setFamily(String)
-
isFamily
public static boolean isFamily(java.lang.String family)Determines if the OS on which Ant is executing matches the given OS family.- Parameters:
family- the family to check for- Returns:
- true if the OS matches
- Since:
- 1.5
-
isName
public static boolean isName(java.lang.String name)Determines if the OS on which Ant is executing matches the given OS name.- Parameters:
name- the OS name to check for- Returns:
- true if the OS matches
- Since:
- 1.7
-
isArch
public static boolean isArch(java.lang.String arch)Determines if the OS on which Ant is executing matches the given OS architecture.- Parameters:
arch- the OS architecture to check for- Returns:
- true if the OS matches
- Since:
- 1.7
-
isVersion
public static boolean isVersion(java.lang.String version)Determines if the OS on which Ant is executing matches the given OS version.- Parameters:
version- the OS version to check for- Returns:
- true if the OS matches
- Since:
- 1.7
-
isOs
public static boolean isOs(java.lang.String family, java.lang.String name, java.lang.String arch, java.lang.String version)Determines if the OS on which Ant is executing matches the given OS family, name, architecture and version- Parameters:
family- The OS familyname- The OS namearch- The OS architectureversion- The OS version- Returns:
- true if the OS matches
- Since:
- 1.7
-