org.apache.maven.api.toolchain

Class ToolchainModel

java.lang.Object

org.apache.maven.api.toolchain.TrackableBase

org.apache.maven.api.toolchain.ToolchainModel

All Implemented Interfaces:

Serializable

@Experimental
 @Generated
 @ThreadSafe
 @Immutable
public class ToolchainModel
extends TrackableBase
implements Serializable

Definition of a toolchain instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.apache.maven.api.toolchain.TrackableBase

GLOBAL_LEVEL, USER_LEVEL

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Method equals.
Dom	getConfiguration() Toolchain configuration information, like location or any information that is to be retrieved.
Map<String,String>	getProvides() Toolchain identification information, which will be matched against project requirements.
String	getType() Type of toolchain: jdk for JDK Standard Toolchain, other value for Custom Toolchain
int	hashCode() Method hashCode.
static ToolchainModel.Builder	newBuilder() Creates a new ToolchainModel builder instance.
static ToolchainModel.Builder	newBuilder(boolean withDefaults) Creates a new ToolchainModel builder instance using default values or not.
static ToolchainModel.Builder	newBuilder(ToolchainModel from) Creates a new ToolchainModel builder instance using the specified object as a basis.
static ToolchainModel.Builder	newBuilder(ToolchainModel from, boolean forceCopy) Creates a new ToolchainModel builder instance using the specified object as a basis.
static ToolchainModel	newInstance() Creates a new ToolchainModel instance.
static ToolchainModel	newInstance(boolean withDefaults) Creates a new ToolchainModel instance using default values or not.
ToolchainModel.Builder	with() Creates a new builder with this object as the basis.
ToolchainModel	withConfiguration(Dom configuration) Creates a new ToolchainModel instance using the specified configuration.
ToolchainModel	withProvides(Map<String,String> provides) Creates a new ToolchainModel instance using the specified provides.
ToolchainModel	withType(String type) Creates a new ToolchainModel instance using the specified type.

Methods inherited from class org.apache.maven.api.toolchain.TrackableBase

getSourceLevel, newBuilder, newBuilder, setSourceLevel

Methods inherited from class java.lang.Object

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

Method Detail

getType

public String getType()

Type of toolchain:

• jdk for JDK Standard Toolchain,
• other value for Custom Toolchain

Returns:

a String

getProvides

@Nonnull
public Map<String,String> getProvides()

Toolchain identification information, which will be matched against project requirements.

For Maven 2.0.9 to 3.2.3, the actual content structure was completely open: each toolchain type would define its own format and semantics. In general, this was a properties format.

Since Maven 3.2.4, the type for this field has been changed to Properties to match the de-facto format.

Each toolchain defines its own properties names and semantics.

Returns:

a Map<String, String>

getConfiguration

public Dom getConfiguration()

Toolchain configuration information, like location or any information that is to be retrieved.

Actual content structure is completely open: each toolchain type will define its own format and semantics.

In general, this is a properties format: <name>value</name> with per-toolchain defined properties names.

Returns:

a Dom

with

@Nonnull
public ToolchainModel.Builder with()

Creates a new builder with this object as the basis.

Overrides:

with in class TrackableBase

Returns:

a Builder

withType

@Nonnull
public ToolchainModel withType(String type)

Creates a new ToolchainModel instance using the specified type.

Parameters:

type - the new String to use

Returns:

a ToolchainModel with the specified type

withProvides

@Nonnull
public ToolchainModel withProvides(Map<String,String> provides)

Creates a new ToolchainModel instance using the specified provides.

Parameters:

provides - the new Map<String, String> to use

Returns:

a ToolchainModel with the specified provides

withConfiguration

@Nonnull
public ToolchainModel withConfiguration(Dom configuration)

Creates a new ToolchainModel instance using the specified configuration.

Parameters:

configuration - the new Dom to use

Returns:

a ToolchainModel with the specified configuration

newInstance

@Nonnull
public static ToolchainModel newInstance()

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

Returns:

a new ToolchainModel

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static ToolchainModel newInstance(boolean withDefaults)

Creates a new ToolchainModel 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 ToolchainModel

newBuilder

@Nonnull
public static ToolchainModel.Builder newBuilder()

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

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

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

Creates a new ToolchainModel 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 ToolchainModel.Builder newBuilder(ToolchainModel from)

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

Parameters:

from - the ToolchainModel instance to use as a basis

Returns:

a new Builder

newBuilder

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

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

Parameters:

from - the ToolchainModel instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class Object

Returns:

int

equals

public boolean equals(Object other)

Method equals.

Overrides:

equals in class Object

Parameters:

other -

Returns:

boolean