Os (Apache Ant API)

org.apache.tools.ant.taskdefs.condition
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

Version:

$Revision: 1.15.2.1 $

Author:

Stefan Bodewig

, Magesh Umasankar

Constructor Summary

Os()

Os(java.lang.String family)

Method Summary

boolean	eval() Determines if the OS on which Ant is executing matches the type of that set in setFamily.
static boolean	isArch(java.lang.String arch) Determines if the OS on which Ant is executing matches the given OS architecture.
static boolean	isFamily(java.lang.String family) Determines if the OS on which Ant is executing matches the given OS family.
static boolean	isName(java.lang.String name) Determines if the OS on which Ant is executing matches the given OS name.
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
static boolean	isVersion(java.lang.String version) Determines if the OS on which Ant is executing matches the given OS version.
void	setArch(java.lang.String arch) Sets the desired OS architecture
void	setFamily(java.lang.String f) Sets the desired OS family type
void	setName(java.lang.String name) Sets the desired OS name
void	setVersion(java.lang.String version) Sets the desired OS version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Os

public Os()

Os

public Os(java.lang.String family)

Method Detail

setFamily

public void setFamily(java.lang.String f)

Sets the desired OS family type

Parameters:

f - The OS family type desired
Possible values:

• dos
• mac
• netware
• os/2
• unix
• windows
• win9x
• z/os

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

public boolean eval()
             throws BuildException

Determines if the OS on which Ant is executing matches the type of that set in setFamily.

Specified by:

eval in interface Condition

BuildException

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.

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.

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.

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.

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 family

name - The OS name

arch - The OS architecture

version - The OS version

Since:

1.7