org.apache.maven.api.settings

Class TrackableBase

java.lang.Object

org.apache.maven.api.settings.TrackableBase

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IdentifiableBase, Settings

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

common base class that contains code to track the source for this instance (USER|GLOBAL)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	GLOBAL_LEVEL
static String	USER_LEVEL

Method Summary

Modifier and Type	Method and Description
String	getSourceLevel()
static TrackableBase.Builder	newBuilder() Creates a new TrackableBase builder instance.
static TrackableBase.Builder	newBuilder(boolean withDefaults) Creates a new TrackableBase builder instance using default values or not.
static TrackableBase.Builder	newBuilder(TrackableBase from) Creates a new TrackableBase builder instance using the specified object as a basis.
static TrackableBase.Builder	newBuilder(TrackableBase from, boolean forceCopy) Creates a new TrackableBase builder instance using the specified object as a basis.
static TrackableBase	newInstance() Creates a new TrackableBase instance.
static TrackableBase	newInstance(boolean withDefaults) Creates a new TrackableBase instance using default values or not.
void	setSourceLevel(String sourceLevel)
TrackableBase.Builder	with() Creates a new builder with this object as the basis.

Methods inherited from class java.lang.Object

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

Field Detail

USER_LEVEL

public static final String USER_LEVEL

See Also:

Constant Field Values

GLOBAL_LEVEL

public static final String GLOBAL_LEVEL

See Also:

Constant Field Values

Method Detail

with

@Nonnull
public TrackableBase.Builder with()

Creates a new builder with this object as the basis.

Returns:

a Builder

newInstance

@Nonnull
public static TrackableBase newInstance()

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

Returns:

a new TrackableBase

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static TrackableBase newInstance(boolean withDefaults)

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

newBuilder

@Nonnull
public static TrackableBase.Builder newBuilder()

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

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

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

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

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

Parameters:

from - the TrackableBase instance to use as a basis

Returns:

a new Builder

newBuilder

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

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

Parameters:

from - the TrackableBase instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder

setSourceLevel

public void setSourceLevel(String sourceLevel)

getSourceLevel

public String getSourceLevel()