org.apache.maven.plugin.enforcer
Class RequireOS

java.lang.Object
  org.apache.maven.plugin.enforcer.RequireOS

All Implemented Interfaces:

org.apache.maven.shared.enforcer.rule.api.EnforcerRule

public class RequireOS
extends Object
implements org.apache.maven.shared.enforcer.rule.api.EnforcerRule

This rule checks that the OS is allowed by combinations of family, name, version and cpu architecture. The behavior is exactly the same as the Maven Os profile activation so the same values are allowed here.

Version:

$Id: RequireOS.java 524303 2007-03-30 22:59:32Z brianf $

Author:

Brian Fox

Field Summary

String	arch Runtime information containing Maven Version.
boolean	display Display detected OS information.
String	family The OS family type desired Possible values: dos mac netware os/2 tandem unix windows win9x z/os os/400
String	message Specify an optional message to the user if the rule fails.
String	name Runtime information containing Maven Version.
static String	OS_ARCH
static String	OS_NAME
static String	OS_VERSION
String	version Runtime information containing Maven Version.

Constructor Summary

RequireOS()

Method Summary

boolean	allParamsEmpty() Helper method to check that at least one of family, name, version or arch is set.
String	determineOsFamily() Helper method to determine the current OS family.
void	displayOSInfo(org.apache.maven.plugin.logging.Log log, boolean info) Log the current OS information
void	execute(org.apache.maven.shared.enforcer.rule.api.EnforcerRuleHelper helper)
String	getArch()
String	getFamily()
String	getName()
Set	getValidFamilies()
String	getVersion()
boolean	isAllowed() Helper method to determine if the current OS is allowed based on the injected values for family, name, version and arch.
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 Note: '!' is allowed at the beginning of the string and still considered valid.
void	setArch(String theArch)
void	setFamily(String theFamily)
void	setName(String theName)
void	setValidFamilies(Set theValidFamilies)
void	setVersion(String theVersion)

Methods inherited from class java.lang.Object

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

Field Detail

family

public String family

The OS family type desired
Possible values:

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

name

public String name

Runtime information containing Maven Version.

version

public String version

Runtime information containing Maven Version.

arch

public String arch

Runtime information containing Maven Version.

message

public String message

Specify an optional message to the user if the rule fails.

display

public boolean display

Display detected OS information.

OS_NAME

public static final String OS_NAME

OS_ARCH

public static final String OS_ARCH

OS_VERSION

public static final String OS_VERSION

Constructor Detail

RequireOS

public RequireOS()

Method Detail

execute

public void execute(org.apache.maven.shared.enforcer.rule.api.EnforcerRuleHelper helper)
             throws org.apache.maven.shared.enforcer.rule.api.EnforcerRuleException

Specified by:

execute in interface org.apache.maven.shared.enforcer.rule.api.EnforcerRule

Throws:

org.apache.maven.shared.enforcer.rule.api.EnforcerRuleException

displayOSInfo

public void displayOSInfo(org.apache.maven.plugin.logging.Log log,
                          boolean info)

Log the current OS information

Parameters:

log -

determineOsFamily

public String determineOsFamily()

Helper method to determine the current OS family.

Returns:

name of current OS family.

isAllowed

public boolean isAllowed()

Helper method to determine if the current OS is allowed based on the injected values for family, name, version and arch.

Returns:

true if the version is allowed.

allParamsEmpty

public boolean allParamsEmpty()

Helper method to check that at least one of family, name, version or arch is set.

Returns:

true if all parameters are empty.

isValidFamily

public 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

Note: '!' is allowed at the beginning of the string and still considered valid.

Parameters:

theFamily - the family to check.

Returns:

true if one of the valid families.

getArch

public String getArch()

Returns:

the arch

setArch

public void setArch(String theArch)

Parameters:

theArch - the arch to set

getFamily

public String getFamily()

Returns:

the family

setFamily

public void setFamily(String theFamily)

Parameters:

theFamily - the family to set

getName

public String getName()

Returns:

the name

setName

public void setName(String theName)

Parameters:

theName - the name to set

getVersion

public String getVersion()

Returns:

the version

setVersion

public void setVersion(String theVersion)

Parameters:

theVersion - the version to set

getValidFamilies

public Set getValidFamilies()

Returns:

the validFamilies

setValidFamilies

public void setValidFamilies(Set theValidFamilies)

Parameters:

theValidFamilies - the validFamilies to set