org.codehaus.plexus.util

Class Os

public class Os extends Object

Condition that tests the OS type.

Since: 1.0

Version: $Revision: 7305 $

Author: Stefan Bodewig Magesh Umasankar Brian Fox

Field Summary
static String	FAMILY_DOS
static String	FAMILY_MAC
static String	FAMILY_NETWARE
static String	FAMILY_OPENVMS
static String	FAMILY_OS2
static String	FAMILY_OS400
static String	FAMILY_TANDEM
static String	FAMILY_UNIX
static String	FAMILY_WIN9X
static String	FAMILY_WINDOWS
static String	FAMILY_ZOS
static String	OS_ARCH
static String	OS_FAMILY
static String	OS_NAME
static String	OS_VERSION

Constructor Summary
	Os() Default constructor
	Os(String family) Constructor that sets the family attribute

Method Summary
boolean	eval() Determines if the current OS matches the type of that set in setFamily.
static Set	getValidFamilies()
static boolean	isArch(String arch) Determines if the current OS matches the given OS architecture.
static boolean	isFamily(String family) Determines if the current OS matches the given OS family.
static boolean	isName(String name) Determines if the current OS matches the given OS name.
static boolean	isOs(String family, String name, String arch, String version) Determines if the current OS matches the given OS family, name, architecture and version.
static boolean	isValidFamily(String theFamily) Helper method to check if the given family is in the following list: dos mac netware os/2 tandem unix windows win9x z/os os/400 openvms
static boolean	isVersion(String version) Determines if the current OS matches the given OS version.
void	setArch(String arch) Sets the desired OS architecture
void	setFamily(String f) Sets the desired OS family type
void	setName(String name) Sets the desired OS name
void	setVersion(String version) Sets the desired OS version

Field Detail

FAMILY_NETWARE

public static final String FAMILY_NETWARE

FAMILY_OPENVMS

public static final String FAMILY_OPENVMS

FAMILY_TANDEM

public static final String FAMILY_TANDEM

FAMILY_WINDOWS

public static final String FAMILY_WINDOWS

Constructor Detail

Os

public Os(String family)

Constructor that sets the family attribute

Parameters: family a String value

Method Detail

eval

public boolean eval()

Determines if the current OS matches the type of that set in setFamily.

getValidFamilies

public static Set getValidFamilies()

Returns: a copy of the valid families

Since: 1.4.2

isArch

public static boolean isArch(String arch)

Determines if the current OS matches the given OS architecture.

Parameters: arch the OS architecture to check for

Returns: true if the OS matches

Since: 1.0

isFamily

public static boolean isFamily(String family)

Determines if the current OS matches the given OS family.

Parameters: family the family to check for

Returns: true if the OS matches

Since: 1.0

isName

public static boolean isName(String name)

Determines if the current OS matches the given OS name.

Parameters: name the OS name to check for

Returns: true if the OS matches

Since: 1.0

isOs

public static boolean isOs(String family, String name, String arch, String version)

Determines if the current OS matches the given OS family, name, architecture and version. The name, archictecture and version are compared to the System properties os.name, os.version and os.arch in a case-independent way.

Parameters: family The OS family name The OS name arch The OS architecture version The OS version

Returns: true if the OS matches

Since: 1.0