org.apache.maven.api.settings

Class Repository

java.lang.Object

org.apache.maven.api.settings.RepositoryBase

org.apache.maven.api.settings.Repository

All Implemented Interfaces:

Serializable

@Experimental
 @Generated
 @ThreadSafe
 @Immutable
public class Repository
extends RepositoryBase
implements Serializable

Repository contains the information needed for establishing connections with remote repository

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
RepositoryPolicy	getReleases() How to handle downloading of releases from this repository
RepositoryPolicy	getSnapshots() How to handle downloading of snapshots from this repository
static Repository.Builder	newBuilder() Creates a new Repository builder instance.
static Repository.Builder	newBuilder(boolean withDefaults) Creates a new Repository builder instance using default values or not.
static Repository.Builder	newBuilder(Repository from) Creates a new Repository builder instance using the specified object as a basis.
static Repository.Builder	newBuilder(Repository from, boolean forceCopy) Creates a new Repository builder instance using the specified object as a basis.
static Repository	newInstance() Creates a new Repository instance.
static Repository	newInstance(boolean withDefaults) Creates a new Repository instance using default values or not.
Repository.Builder	with() Creates a new builder with this object as the basis.
Repository	withId(String id) Creates a new Repository instance using the specified id.
Repository	withLayout(String layout) Creates a new Repository instance using the specified layout.
Repository	withName(String name) Creates a new Repository instance using the specified name.
Repository	withReleases(RepositoryPolicy releases) Creates a new Repository instance using the specified releases.
Repository	withSnapshots(RepositoryPolicy snapshots) Creates a new Repository instance using the specified snapshots.
Repository	withUrl(String url) Creates a new Repository instance using the specified url.

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

getId, getLayout, getName, getUrl, newBuilder, newBuilder

Methods inherited from class java.lang.Object

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

Method Detail

getReleases

public RepositoryPolicy getReleases()

How to handle downloading of releases from this repository

Returns:

a RepositoryPolicy

getSnapshots

public RepositoryPolicy getSnapshots()

How to handle downloading of snapshots from this repository

Returns:

a RepositoryPolicy

with

@Nonnull
public Repository.Builder with()

Creates a new builder with this object as the basis.

Overrides:

with in class RepositoryBase

Returns:

a Builder

withId

@Nonnull
public Repository withId(String id)

Creates a new Repository instance using the specified id.

Overrides:

withId in class RepositoryBase

Parameters:

id - the new String to use

Returns:

a Repository with the specified id

withName

@Nonnull
public Repository withName(String name)

Creates a new Repository instance using the specified name.

Overrides:

withName in class RepositoryBase

Parameters:

name - the new String to use

Returns:

a Repository with the specified name

withUrl

@Nonnull
public Repository withUrl(String url)

Creates a new Repository instance using the specified url.

Overrides:

withUrl in class RepositoryBase

Parameters:

url - the new String to use

Returns:

a Repository with the specified url

withLayout

@Nonnull
public Repository withLayout(String layout)

Creates a new Repository instance using the specified layout.

Overrides:

withLayout in class RepositoryBase

Parameters:

layout - the new String to use

Returns:

a Repository with the specified layout

withReleases

@Nonnull
public Repository withReleases(RepositoryPolicy releases)

Creates a new Repository instance using the specified releases.

Parameters:

releases - the new RepositoryPolicy to use

Returns:

a Repository with the specified releases

withSnapshots

@Nonnull
public Repository withSnapshots(RepositoryPolicy snapshots)

Creates a new Repository instance using the specified snapshots.

Parameters:

snapshots - the new RepositoryPolicy to use

Returns:

a Repository with the specified snapshots

newInstance

@Nonnull
public static Repository newInstance()

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

Returns:

a new Repository

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static Repository newInstance(boolean withDefaults)

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

newBuilder

@Nonnull
public static Repository.Builder newBuilder()

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

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

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

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

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

Parameters:

from - the Repository instance to use as a basis

Returns:

a new Builder

newBuilder

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

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

Parameters:

from - the Repository instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder

equals

public boolean equals(Object obj)

Overrides:

equals in class RepositoryBase

See Also:

RepositoryBase.equals(java.lang.Object)