saker.maven.support Documentation TaskDoc JavaDoc Packages
public final class MavenOperationConfiguration implements Externalizable
Holds the configuration information for operations that work with Maven repositories.

The class contains the configuration data that should be used to setup and initialize the associated operation. It determines which repositories and how they should be used.

Cliens can use builder() to create a new configuration or defaults() to get the default configuration.

Nested types
public static final class
Username-password based authentication configuration.
public abstract static class
Abstract superclass for possible authentication types for remote repositories.
public static final class
A builder class for creating a MavenOperationConfiguration.
public static final class
Authentication configuration that holds the local file system path to a private key store and its associated pass phrase.
public static final class
Contains configurations for a remote Maven repository.
public static final class
Artifact policy configuration for Maven operations.
Constructors
public
Methods
public static Builder
public static Builder
builder(SakerPath localRepositoryPath)
Creates a new MavenOperationConfiguration builder with the specified local repository path.
public static Builder
Creates a new build that is initialized with the values from the argument.
public static MavenOperationConfiguration
public static MavenOperationConfiguration
defaults(TaskContext taskcontext)
Gets the Maven operation configuration that uses the default values.
public boolean
Indicates whether some other object is "equal to" this one.
public SakerPath
Gets the local file system path for the local repository.
public Set<extends RepositoryConfiguration>
Gets the remote repositories that should be used for the operation.
public int
Returns a hash code value for the object.
public void
The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
public String
Returns a string representation of the object.
public void
The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.
Inherited methods
From: Object
public static Builder builder()
Creates a new MavenOperationConfiguration builder.
The new builder.
public static Builder builder(SakerPath localRepositoryPath) throws NullPointerException
Creates a new MavenOperationConfiguration builder with the specified local repository path.

No remote repositories are added by default.

localRepositoryPathThe local repository path.
The new builder.
NullPointerExceptionIf the argument is null.
Creates a new build that is initialized with the values from the argument.
copyThe configuration to copy.
The builder.
NullPointerExceptionIf the argument is null.
Gets the Maven operation configuration that causes the operation to use the defaults.

See the default values in the associated getter method.

The getter methods will all return null to signal that the default should be used.

The defaults configuration.
Gets the Maven operation configuration that uses the default values.

It has the local repository path to the default repository location, and uses the Maven Central as the remote repository.

taskcontextThe task context.
The default configuration.
NullPointerExceptionIf the task context is null.
saker.maven.support 0.8.7
public boolean equals(Object obj)
Overridden from: Object
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

objthe reference object with which to compare.
true if this object is the same as the obj argument; false otherwise.
Gets the local file system path for the local repository.

The default is: {user.home}/.m2/repository

The local path or null if the default should be used.
Gets the remote repositories that should be used for the operation.

The default is https://repo.maven.apache.org/maven2/ with the ID of central and layout default. The snapshots are disabled.

The repositories or null if the default should be used.
public int hashCode()
Overridden from: Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the Object.equals(Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

a hash code value for this object.
Overridden from: Externalizable
The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.
inthe stream to read data from in order to restore the object
IOExceptionif I/O errors occur
ClassNotFoundExceptionIf the class for an object being restored cannot be found.
public String toString()
Overridden from: Object
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 
a string representation of the object.
public void writeExternal(ObjectOutput out) throws IOException
Overridden from: Externalizable
The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.
outthe stream to write the object to
IOExceptionIncludes any I/O exceptions that may occur