org.apache.maven.api.settings

Class IdentifiableBase

java.lang.Object

org.apache.maven.api.settings.TrackableBase

org.apache.maven.api.settings.IdentifiableBase

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Mirror, Profile, Proxy, Server

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

Base class for Mirror, Profile, Proxy and Server.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

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

GLOBAL_LEVEL, USER_LEVEL

Method Summary

Modifier and Type	Method and Description
String	getId()
static IdentifiableBase.Builder	newBuilder() Creates a new IdentifiableBase builder instance.
static IdentifiableBase.Builder	newBuilder(boolean withDefaults) Creates a new IdentifiableBase builder instance using default values or not.
static IdentifiableBase.Builder	newBuilder(IdentifiableBase from) Creates a new IdentifiableBase builder instance using the specified object as a basis.
static IdentifiableBase.Builder	newBuilder(IdentifiableBase from, boolean forceCopy) Creates a new IdentifiableBase builder instance using the specified object as a basis.
static IdentifiableBase	newInstance() Creates a new IdentifiableBase instance.
static IdentifiableBase	newInstance(boolean withDefaults) Creates a new IdentifiableBase instance using default values or not.
IdentifiableBase.Builder	with() Creates a new builder with this object as the basis.
IdentifiableBase	withId(String id) Creates a new IdentifiableBase instance using the specified id.

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

getSourceLevel, newBuilder, newBuilder, setSourceLevel

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

Returns:

a String

with

@Nonnull
public IdentifiableBase.Builder with()

Creates a new builder with this object as the basis.

Overrides:

with in class TrackableBase

Returns:

a Builder

withId

@Nonnull
public IdentifiableBase withId(String id)

Creates a new IdentifiableBase instance using the specified id.

Parameters:

id - the new String to use

Returns:

a IdentifiableBase with the specified id

newInstance

@Nonnull
public static IdentifiableBase newInstance()

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

Returns:

a new IdentifiableBase

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static IdentifiableBase newInstance(boolean withDefaults)

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

newBuilder

@Nonnull
public static IdentifiableBase.Builder newBuilder()

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

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

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

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

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

Parameters:

from - the IdentifiableBase instance to use as a basis

Returns:

a new Builder

newBuilder

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

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

Parameters:

from - the IdentifiableBase instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder