DependencyManagement.java

package org.eclipse.aether.collection;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *  http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.util.Collection;
import java.util.Map;

import org.eclipse.aether.graph.Dependency;
import org.eclipse.aether.graph.Exclusion;

/**
 * The management updates to apply to a dependency.
 *
 * @see DependencyManager#manageDependency(Dependency)
 */
public final class DependencyManagement
{

    private String version;

    /**
     * @since 1.2.0
     */
    private String versionSourceHint;

    private String scope;

    /**
     * @since 1.2.0
     */
    private String scopeSourceHint;

    private Boolean optional;

    /**
     * @since 1.2.0
     */
    private String optionalSourceHint;

    private Collection<Exclusion> exclusions;

    /**
     * @since 1.2.0
     */
    private String exclusionsSourceHint;

    private Map<String, String> properties;

    /**
     * @since 1.2.0
     */
    private String propertiesSourceHint;

    /**
     * Creates an empty management update.
     */
    public DependencyManagement()
    {
        // enables default constructor
        super();
    }

    /**
     * Gets the new version to apply to the dependency.
     *
     * @return The new version or {@code null} if the version is not managed and the existing dependency version should
     * remain unchanged.
     */
    public String getVersion()
    {
        return version;
    }

    /**
     * Sets the new version to apply to the dependency.
     *
     * @param version The new version, may be {@code null} if the version is not managed.
     * @return This management update for chaining, never {@code null}.
     */
    public DependencyManagement setVersion( String version )
    {
        this.version = version;
        return this;
    }

    /**
     * Gets an informational hint describing the source declaring the version management.
     * @return An informational hint describing the source declaring the version management or {@code null}.
     * @since 1.2.0
     */
    public String getVersionSourceHint()
    {
        return this.versionSourceHint;
    }

    /**
     * Sets the informational hint describing the source declaring the version management.
     * @param value The new informational hint decsribing the source declaring the version management or {@code null}.
     * @return This management update for chaining, never {@code null}.
     * @since 1.2.0
     */
    public DependencyManagement setVersionSourceHint( final String value )
    {
        this.versionSourceHint = value;
        return this;
    }

    /**
     * Gets the new scope to apply to the dependency.
     *
     * @return The new scope or {@code null} if the scope is not managed and the existing dependency scope should remain
     * unchanged.
     */
    public String getScope()
    {
        return scope;
    }

    /**
     * Sets the new scope to apply to the dependency.
     *
     * @param scope The new scope, may be {@code null} if the scope is not managed.
     * @return This management update for chaining, never {@code null}.
     */
    public DependencyManagement setScope( String scope )
    {
        this.scope = scope;
        return this;
    }

    /**
     * Gets an informational hint describing the source declaring the scope management.
     * @return An informational hint describing the source declaring the scope management or {@code null}.
     * @since 1.2.0
     */
    public String getScopeSourceHint()
    {
        return this.scopeSourceHint;
    }

    /**
     * Sets the informational hint describing the source declaring the scope management.
     * @param value The new informational hint decsribing the source declaring the scope management or {@code null}.
     * @return This management update for chaining, never {@code null}.
     * @since 1.2.0
     */
    public DependencyManagement setScopeSourceHint( final String value )
    {
        this.scopeSourceHint = value;
        return this;
    }

    /**
     * Gets the new optional flag to apply to the dependency.
     *
     * @return The new optional flag or {@code null} if the flag is not managed and the existing optional flag of the
     * dependency should remain unchanged.
     */
    public Boolean getOptional()
    {
        return optional;
    }

    /**
     * Sets the new optional flag to apply to the dependency.
     *
     * @param optional The optional flag, may be {@code null} if the flag is not managed.
     * @return This management update for chaining, never {@code null}.
     */
    public DependencyManagement setOptional( Boolean optional )
    {
        this.optional = optional;
        return this;
    }

    /**
     * Gets an informational hint describing the source declaring the optionality management.
     * @return An informational hint describing the source declaring the optionality management or {@code null}.
     * @since 1.2.0
     */
    public String getOptionalitySourceHint()
    {
        return this.optionalSourceHint;
    }

    /**
     * Sets the informational hint describing the source declaring the optionality management.
     * @param value The new informational hint decsribing the source declaring the optionality management or
     * {@code null}.
     * @return This management update for chaining, never {@code null}.
     * @since 1.2.0
     */
    public DependencyManagement setOptionalitySourceHint( final String value )
    {
        this.optionalSourceHint = value;
        return this;
    }

    /**
     * Gets the new exclusions to apply to the dependency. Note that this collection denotes the complete set of
     * exclusions for the dependency, i.e. the dependency manager controls whether any existing exclusions get merged
     * with information from dependency management or overridden by it.
     *
     * @return The new exclusions or {@code null} if the exclusions are not managed and the existing dependency
     * exclusions should remain unchanged.
     */
    public Collection<Exclusion> getExclusions()
    {
        return exclusions;
    }

    /**
     * Sets the new exclusions to apply to the dependency. Note that this collection denotes the complete set of
     * exclusions for the dependency, i.e. the dependency manager controls whether any existing exclusions get merged
     * with information from dependency management or overridden by it.
     *
     * @param exclusions The new exclusions, may be {@code null} if the exclusions are not managed.
     * @return This management update for chaining, never {@code null}.
     */
    public DependencyManagement setExclusions( Collection<Exclusion> exclusions )
    {
        this.exclusions = exclusions;
        return this;
    }

    /**
     * Gets an informational hint describing the source declaring the exclusions management.
     * @return An informational hint describing the source declaring the exclusions management or {@code null}.
     * @since 1.2.0
     */
    public String getExclusionsSourceHint()
    {
        return this.exclusionsSourceHint;
    }

    /**
     * Sets the informational hint describing the source declaring the exclusions management.
     * @param value The new informational hint decsribing the source declaring the exclusions management or
     * {@code null}.
     * @return This management update for chaining, never {@code null}.
     * @since 1.2.0
     */
    public DependencyManagement setExclusionsSourceHint( final String value )
    {
        this.exclusionsSourceHint = value;
        return this;
    }

    /**
     * Gets the new properties to apply to the dependency. Note that this map denotes the complete set of properties,
     * i.e. the dependency manager controls whether any existing properties get merged with the information from
     * dependency management or overridden by it.
     *
     * @return The new artifact properties or {@code null} if the properties are not managed and the existing properties
     * should remain unchanged.
     */
    public Map<String, String> getProperties()
    {
        return properties;
    }

    /**
     * Sets the new properties to apply to the dependency. Note that this map denotes the complete set of properties,
     * i.e. the dependency manager controls whether any existing properties get merged with the information from
     * dependency management or overridden by it.
     *
     * @param properties The new artifact properties, may be {@code null} if the properties are not managed.
     * @return This management update for chaining, never {@code null}.
     */
    public DependencyManagement setProperties( Map<String, String> properties )
    {
        this.properties = properties;
        return this;
    }

    /**
     * Gets an informational hint describing the source declaring the properties management.
     * @return An informational hint describing the source declaring the properties management or {@code null}.
     * @since 1.2.0
     */
    public String getPropertiesSourceHint()
    {
        return this.propertiesSourceHint;
    }

    /**
     * Sets the informational hint describing the source declaring the properties management.
     * @param value The new informational hint decsribing the source declaring the properties management or
     * {@code null}.
     * @return This management update for chaining, never {@code null}.
     * @since 1.2.0
     */
    public DependencyManagement setPropertiesSourceHint( final String value )
    {
        this.propertiesSourceHint = value;
        return this;
    }

}