org.apache.maven.plugins.enforcer

Class RequireOS

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.RequireOS

All Implemented Interfaces:

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

public class RequireOS
extends AbstractStandardEnforcerRule

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$

Author:

Brian Fox

Field Summary

Fields

Modifier and Type	Field and Description
String	arch Deprecated. the visibility will be reduced to private with the next major version
boolean	display Deprecated. the visibility will be reduced to private with the next major version
String	family Deprecated. the visibility will be reduced to private with the next major version
String	name Deprecated. the visibility will be reduced to private with the next major version
String	version Deprecated. the visibility will be reduced to private with the next major version

Fields inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

message

Constructor Summary

Constructors

Constructor and Description
RequireOS() Instantiates a new RequireOS.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allParamsEmpty() Helper method to check that at least one of family, name, version or arch is set.
void	displayOSInfo(org.apache.maven.plugin.logging.Log log, boolean info) Log the current OS information.
void	execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
String	getArch() Gets the arch.
String	getCacheId()
String	getFamily() Gets the family.
String	getName() Gets the name.
String	getVersion() Gets the version.
boolean	isAllowed() Helper method to determine if the current OS is allowed based on the injected values for family, name, version and arch.
boolean	isCacheable()
boolean	isDisplay()
boolean	isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule theCachedRule)
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: '!'
void	setArch(String theArch) Sets the arch.
void	setDisplay(boolean display)
void	setFamily(String theFamily) Sets the family.
void	setName(String theName) Sets the name.
void	setVersion(String theVersion) Sets the version.

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

getMessage, setMessage

Methods inherited from class java.lang.Object

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

Field Detail

family

public String family

Deprecated. the visibility will be reduced to private with the next major version

The OS family type desired
Possible values:

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

See Also:

#setFamily(String)}, #getFamily()}

name

public String name

Deprecated. the visibility will be reduced to private with the next major version

The OS name desired.

See Also:

#setName(String)}, #getName()}

version

public String version

Deprecated. the visibility will be reduced to private with the next major version

The OS version desired.

See Also:

#setVersion(String)}, #getVersion()}

arch

public String arch

Deprecated. the visibility will be reduced to private with the next major version

The OS architecture desired.

See Also:

#setArch(String)}, #getArch()}

display

public boolean display

Deprecated. the visibility will be reduced to private with the next major version

Display detected OS information.

See Also:

#setDisplay(boolean)}, #isDisplay()}

Constructor Detail

RequireOS

public RequireOS()

Instantiates a new RequireOS.

Method Detail

execute

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

Throws:

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

displayOSInfo

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

Log the current OS information.

Parameters:

log - the log

info - the info

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()

Gets the arch.

Returns:

the arch

setArch

public void setArch(String theArch)

Sets the arch.

Parameters:

theArch - the arch to set

getFamily

public String getFamily()

Gets the family.

Returns:

the family

setFamily

public void setFamily(String theFamily)

Sets the family.

Parameters:

theFamily - the family to set

getName

public String getName()

Gets the name.

Returns:

the name

setName

public void setName(String theName)

Sets the name.

Parameters:

theName - the name to set

getVersion

public String getVersion()

Gets the version.

Returns:

the version

setVersion

public void setVersion(String theVersion)

Sets the version.

Parameters:

theVersion - the version to set

setDisplay

public final void setDisplay(boolean display)

isDisplay

public final boolean isDisplay()

getCacheId

public String getCacheId()

isCacheable

public boolean isCacheable()

isResultValid

public boolean isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule theCachedRule)