org.eclipse.aether.resolution

## Class VersionRangeRequest

- java.lang.Object
- - org.eclipse.aether.resolution.VersionRangeRequest

-     public final class VersionRangeRequest
      extends Object

  A request to resolve a version range.
  See Also:
    `RepositorySystem.resolveVersionRange(RepositorySystemSession, VersionRangeRequest)`

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `VersionRangeRequest()` Creates an uninitialized request.
    `VersionRangeRequest(Artifact artifact, List<RemoteRepository> repositories, String context)` Creates a request with the specified properties.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `VersionRangeRequest` | `addRepository(RemoteRepository repository)` Adds the specified repository for the resolution.
    `Artifact` | `getArtifact()` Gets the artifact whose version range shall be resolved.
    `List<RemoteRepository>` | `getRepositories()` Gets the repositories to resolve the version range from.
    `String` | `getRequestContext()` Gets the context in which this request is made.
    `RequestTrace` | `getTrace()` Gets the trace information that describes the higher level request/operation in which this request is issued.
    `VersionRangeRequest` | `setArtifact(Artifact artifact)` Sets the artifact whose version range shall be resolved.
    `VersionRangeRequest` | `setRepositories(List<RemoteRepository> repositories)` Sets the repositories to resolve the version range from.
    `VersionRangeRequest` | `setRequestContext(String context)` Sets the context in which this request is made.
    `VersionRangeRequest` | `setTrace(RequestTrace trace)` Sets the trace information that describes the higher level request/operation in which this request is issued.
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### VersionRangeRequest

          public VersionRangeRequest()

      Creates an uninitialized request.

    - #### VersionRangeRequest

          public VersionRangeRequest(Artifact artifact,
                             List<RemoteRepository> repositories,
                             String context)

      Creates a request with the specified properties.
      Parameters:
        `artifact` - The artifact whose version range should be resolved, may be `null`.
        `repositories` - The repositories to resolve the version from, may be `null`.
        `context` - The context in which this request is made, may be `null`.

  - ### Method Detail

    - #### getArtifact

          public Artifact getArtifact()

      Gets the artifact whose version range shall be resolved.
      Returns:
        The artifact or `null` if not set.

    - #### setArtifact

          public VersionRangeRequest setArtifact(Artifact artifact)

      Sets the artifact whose version range shall be resolved.
      Parameters:
        `artifact` - The artifact, may be `null`.
      Returns:
        This request for chaining, never `null`.

    - #### getRepositories

          public List<RemoteRepository> getRepositories()

      Gets the repositories to resolve the version range from.
      Returns:
        The repositories, never `null`.

    - #### setRepositories

          public VersionRangeRequest setRepositories(List<RemoteRepository> repositories)

      Sets the repositories to resolve the version range from.
      Parameters:
        `repositories` - The repositories, may be `null`.
      Returns:
        This request for chaining, never `null`.

    - #### addRepository

          public VersionRangeRequest addRepository(RemoteRepository repository)

      Adds the specified repository for the resolution.
      Parameters:
        `repository` - The repository to add, may be `null`.
      Returns:
        This request for chaining, never `null`.

    - #### getRequestContext

          public String getRequestContext()

      Gets the context in which this request is made.
      Returns:
        The context, never `null`.

    - #### setRequestContext

          public VersionRangeRequest setRequestContext(String context)

      Sets the context in which this request is made.
      Parameters:
        `context` - The context, may be `null`.
      Returns:
        This request for chaining, never `null`.

    - #### getTrace

          public RequestTrace getTrace()

      Gets the trace information that describes the higher level request/operation in which this request is issued.
      Returns:
        The trace information about the higher level operation or `null` if none.

    - #### setTrace

          public VersionRangeRequest setTrace(RequestTrace trace)

      Sets the trace information that describes the higher level request/operation in which this request is issued.
      Parameters:
        `trace` - The trace information about the higher level operation, may be `null`.
      Returns:
        This request for chaining, never `null`.

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

Copyright © 2010-2012 The Eclipse Foundation. All Rights Reserved.