org.apache.maven.api.model

Class ActivationOS

java.lang.Object

org.apache.maven.api.model.ActivationOS

All Implemented Interfaces:

Serializable, InputLocationTracker

@Experimental
 @Generated
 @ThreadSafe
 @Immutable
public class ActivationOS
extends Object
implements Serializable, InputLocationTracker

This is an activator which will detect an operating system's attributes in order to activate its profile.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActivationOS.Builder Builder class used to create ActivationOS instances.

Method Summary

Modifier and Type	Method and Description
String	getArch() The architecture of the operating system to be used to activate the profile.
String	getFamily() The general family of the OS to be used to activate the profile, such as windows or unix.
InputLocation	getLocation(Object key) Gets the location of the specified field in the input source.
String	getName() The name of the operating system to be used to activate the profile.
String	getVersion() The version of the operating system to be used to activate the profile.
static ActivationOS.Builder	newBuilder() Creates a new ActivationOS builder instance.
static ActivationOS.Builder	newBuilder(ActivationOS from) Creates a new ActivationOS builder instance using the specified object as a basis.
static ActivationOS.Builder	newBuilder(ActivationOS from, boolean forceCopy) Creates a new ActivationOS builder instance using the specified object as a basis.
static ActivationOS.Builder	newBuilder(boolean withDefaults) Creates a new ActivationOS builder instance using default values or not.
static ActivationOS	newInstance() Creates a new ActivationOS instance.
static ActivationOS	newInstance(boolean withDefaults) Creates a new ActivationOS instance using default values or not.
ActivationOS.Builder	with() Creates a new builder with this object as the basis.
ActivationOS	withArch(String arch) Creates a new ActivationOS instance using the specified arch.
ActivationOS	withFamily(String family) Creates a new ActivationOS instance using the specified family.
ActivationOS	withName(String name) Creates a new ActivationOS instance using the specified name.
ActivationOS	withVersion(String version) Creates a new ActivationOS instance using the specified version.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

The name of the operating system to be used to activate the profile. This must be an exact match of the ${os.name} Java property, such as Windows XP.

Returns:

a String

getFamily

public String getFamily()

The general family of the OS to be used to activate the profile, such as windows or unix.

Returns:

a String

getArch

public String getArch()

The architecture of the operating system to be used to activate the profile.

Returns:

a String

getVersion

public String getVersion()

The version of the operating system to be used to activate the profile.

Returns:

a String

getLocation

public InputLocation getLocation(Object key)

Gets the location of the specified field in the input source.

Specified by:

getLocation in interface InputLocationTracker

with

@Nonnull
public ActivationOS.Builder with()

Creates a new builder with this object as the basis.

Returns:

a Builder

withName

@Nonnull
public ActivationOS withName(String name)

Creates a new ActivationOS instance using the specified name.

Parameters:

name - the new String to use

Returns:

a ActivationOS with the specified name

withFamily

@Nonnull
public ActivationOS withFamily(String family)

Creates a new ActivationOS instance using the specified family.

Parameters:

family - the new String to use

Returns:

a ActivationOS with the specified family

withArch

@Nonnull
public ActivationOS withArch(String arch)

Creates a new ActivationOS instance using the specified arch.

Parameters:

arch - the new String to use

Returns:

a ActivationOS with the specified arch

withVersion

@Nonnull
public ActivationOS withVersion(String version)

Creates a new ActivationOS instance using the specified version.

Parameters:

version - the new String to use

Returns:

a ActivationOS with the specified version

newInstance

@Nonnull
public static ActivationOS newInstance()

Creates a new ActivationOS instance. Equivalent to newInstance( true ).

Returns:

a new ActivationOS

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static ActivationOS newInstance(boolean withDefaults)

Creates a new ActivationOS instance using default values or not. Equivalent to newBuilder( withDefaults ).build().

Parameters:

withDefaults - the boolean indicating whether default values should be used

Returns:

a new ActivationOS

newBuilder

@Nonnull
public static ActivationOS.Builder newBuilder()

Creates a new ActivationOS builder instance. Equivalent to newBuilder( true ).

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

@Nonnull
public static ActivationOS.Builder newBuilder(boolean withDefaults)

Creates a new ActivationOS builder instance using default values or not.

Parameters:

withDefaults - the boolean indicating whether default values should be used

Returns:

a new Builder

newBuilder

@Nonnull
public static ActivationOS.Builder newBuilder(ActivationOS from)

Creates a new ActivationOS builder instance using the specified object as a basis. Equivalent to newBuilder( from, false ).

Parameters:

from - the ActivationOS instance to use as a basis

Returns:

a new Builder

newBuilder

@Nonnull
public static ActivationOS.Builder newBuilder(ActivationOS from,
                                                       boolean forceCopy)

Creates a new ActivationOS builder instance using the specified object as a basis.

Parameters:

from - the ActivationOS instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder