Activation

// =================== DO NOT EDIT THIS FILE ====================
//  Generated by Modello Velocity from model.vm
//  template, any modifications will be overwritten.
// ==============================================================
package org.apache.maven.api.model;

import java.io.Serializable;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Generated;
import org.apache.maven.api.annotations.Immutable;
import org.apache.maven.api.annotations.Nonnull;
import org.apache.maven.api.annotations.NotThreadSafe;
import org.apache.maven.api.annotations.ThreadSafe;

/**
 * The conditions within the build runtime environment which will trigger the
 * automatic inclusion of the build profile. Multiple conditions can be defined, which must
 * be all satisfied to activate the profile.
 */
@Experimental
@Generated @ThreadSafe @Immutable
public class Activation
    implements Serializable, InputLocationTracker
{
    /**
     * If set to true, this profile will be active unless another profile in this
     * pom is activated using the command line -P option or by one of that profile's
     * activators.
     */
    final boolean activeByDefault;
    /**
     * Specifies that this profile will be activated when a matching JDK is detected.
     * For example, {@code 1.4} only activates on JDKs versioned 1.4,
     * while {@code !1.4} matches any JDK that is not version 1.4. Ranges are supported too:
     * {@code [1.5,)} activates when the JDK is 1.5 minimum.
     */
    final String jdk;
    /**
     * Specifies that this profile will be activated when matching operating system
     * attributes are detected.
     */
    final ActivationOS os;
    /**
     * Specifies that this profile will be activated when this property is
     * specified.
     */
    final ActivationProperty property;
    /**
     * Specifies that this profile will be activated based on existence of a file.
     */
    final ActivationFile file;
    /**
     * Specifies that this profile will be activated based on the project's packaging.
     */
    final String packaging;
    /** Locations */
    final Map<Object, InputLocation> locations;

    /**
      * Constructor for this class, package protected.
      * @see Builder#build()
      */
    Activation(
        boolean activeByDefault,
        String jdk,
        ActivationOS os,
        ActivationProperty property,
        ActivationFile file,
        String packaging,
        Map<Object, InputLocation> locations
    ) {
        this.activeByDefault = activeByDefault;
        this.jdk = jdk;
        this.os = os;
        this.property = property;
        this.file = file;
        this.packaging = packaging;
        this.locations = ImmutableCollections.copy(locations);
    }

    /**
     * If set to true, this profile will be active unless another profile in this
     * pom is activated using the command line -P option or by one of that profile's
     * activators.
     *
     * @return a {@code boolean}
     */
    public boolean isActiveByDefault() {
        return this.activeByDefault;
    }

    /**
     * Specifies that this profile will be activated when a matching JDK is detected.
     * For example, {@code 1.4} only activates on JDKs versioned 1.4,
     * while {@code !1.4} matches any JDK that is not version 1.4. Ranges are supported too:
     * {@code [1.5,)} activates when the JDK is 1.5 minimum.
     *
     * @return a {@code String}
     */
    public String getJdk() {
        return this.jdk;
    }

    /**
     * Specifies that this profile will be activated when matching operating system
     * attributes are detected.
     *
     * @return a {@code ActivationOS}
     */
    public ActivationOS getOs() {
        return this.os;
    }

    /**
     * Specifies that this profile will be activated when this property is
     * specified.
     *
     * @return a {@code ActivationProperty}
     */
    public ActivationProperty getProperty() {
        return this.property;
    }

    /**
     * Specifies that this profile will be activated based on existence of a file.
     *
     * @return a {@code ActivationFile}
     */
    public ActivationFile getFile() {
        return this.file;
    }

    /**
     * Specifies that this profile will be activated based on the project's packaging.
     *
     * @return a {@code String}
     */
    public String getPackaging() {
        return this.packaging;
    }

    /**
     * Gets the location of the specified field in the input source.
     */
    public InputLocation getLocation(Object key) {
        return locations != null ? locations.get(key) : null;
    }

    /**
     * Creates a new builder with this object as the basis.
     *
     * @return a {@code Builder}
     */
    @Nonnull
    public Builder with() {
        return newBuilder(this);
    }
    /**
     * Creates a new {@code Activation} instance using the specified activeByDefault.
     *
     * @param activeByDefault the new {@code boolean} to use
     * @return a {@code Activation} with the specified activeByDefault
     */
    @Nonnull
    public Activation withActiveByDefault(boolean activeByDefault) {
        return newBuilder(this, true).activeByDefault(activeByDefault).build();
    }
    /**
     * Creates a new {@code Activation} instance using the specified jdk.
     *
     * @param jdk the new {@code String} to use
     * @return a {@code Activation} with the specified jdk
     */
    @Nonnull
    public Activation withJdk(String jdk) {
        return newBuilder(this, true).jdk(jdk).build();
    }
    /**
     * Creates a new {@code Activation} instance using the specified os.
     *
     * @param os the new {@code ActivationOS} to use
     * @return a {@code Activation} with the specified os
     */
    @Nonnull
    public Activation withOs(ActivationOS os) {
        return newBuilder(this, true).os(os).build();
    }
    /**
     * Creates a new {@code Activation} instance using the specified property.
     *
     * @param property the new {@code ActivationProperty} to use
     * @return a {@code Activation} with the specified property
     */
    @Nonnull
    public Activation withProperty(ActivationProperty property) {
        return newBuilder(this, true).property(property).build();
    }
    /**
     * Creates a new {@code Activation} instance using the specified file.
     *
     * @param file the new {@code ActivationFile} to use
     * @return a {@code Activation} with the specified file
     */
    @Nonnull
    public Activation withFile(ActivationFile file) {
        return newBuilder(this, true).file(file).build();
    }
    /**
     * Creates a new {@code Activation} instance using the specified packaging.
     *
     * @param packaging the new {@code String} to use
     * @return a {@code Activation} with the specified packaging
     */
    @Nonnull
    public Activation withPackaging(String packaging) {
        return newBuilder(this, true).packaging(packaging).build();
    }

    /**
     * Creates a new {@code Activation} instance.
     * Equivalent to {@code newInstance(true)}.
     * @see #newInstance(boolean)
     *
     * @return a new {@code Activation}
     */
    @Nonnull
    public static Activation newInstance() {
        return newInstance(true);
    }

    /**
     * Creates a new {@code Activation} instance using default values or not.
     * Equivalent to {@code newBuilder(withDefaults).build()}.
     *
     * @param withDefaults the boolean indicating whether default values should be used
     * @return a new {@code Activation}
     */
    @Nonnull
    public static Activation newInstance(boolean withDefaults) {
        return newBuilder(withDefaults).build();
    }

    /**
     * Creates a new {@code Activation} builder instance.
     * Equivalent to {@code newBuilder(true)}.
     * @see #newBuilder(boolean)
     *
     * @return a new {@code Builder}
     */
    @Nonnull
    public static Builder newBuilder() {
        return newBuilder(true);
    }

    /**
     * Creates a new {@code Activation} builder instance using default values or not.
     *
     * @param withDefaults the boolean indicating whether default values should be used
     * @return a new {@code Builder}
     */
    @Nonnull
    public static Builder newBuilder(boolean withDefaults) {
        return new Builder(withDefaults);
    }

    /**
     * Creates a new {@code Activation} builder instance using the specified object as a basis.
     * Equivalent to {@code newBuilder(from, false)}.
     *
     * @param from the {@code Activation} instance to use as a basis
     * @return a new {@code Builder}
     */
    @Nonnull
    public static Builder newBuilder(Activation from) {
        return newBuilder(from, false);
    }

    /**
     * Creates a new {@code Activation} builder instance using the specified object as a basis.
     *
     * @param from the {@code Activation} instance to use as a basis
     * @param forceCopy the boolean indicating if a copy should be forced
     * @return a new {@code Builder}
     */
    @Nonnull
    public static Builder newBuilder(Activation from, boolean forceCopy) {
        return new Builder(from, forceCopy);
    }

    /**
     * Builder class used to create Activation instances.
     * @see #with()
     * @see #newBuilder()
     */
    @NotThreadSafe
    public static class Builder
    {
        Activation base;
        Boolean activeByDefault;
        String jdk;
        ActivationOS os;
        ActivationProperty property;
        ActivationFile file;
        String packaging;
        Map<Object, InputLocation> locations;

        Builder(boolean withDefaults) {
            if (withDefaults) {
                this.activeByDefault = false;
            }
        }

        Builder(Activation base, boolean forceCopy) {
            if (forceCopy) {
                this.activeByDefault = base.activeByDefault;
                this.jdk = base.jdk;
                this.os = base.os;
                this.property = base.property;
                this.file = base.file;
                this.packaging = base.packaging;
                this.locations = base.locations;
            } else {
                this.base = base;
            }
        }

        @Nonnull
        public Builder activeByDefault(boolean activeByDefault) {
            this.activeByDefault = activeByDefault;
            return this;
        }

        @Nonnull
        public Builder jdk(String jdk) {
            this.jdk = jdk;
            return this;
        }

        @Nonnull
        public Builder os(ActivationOS os) {
            this.os = os;
            return this;
        }

        @Nonnull
        public Builder property(ActivationProperty property) {
            this.property = property;
            return this;
        }

        @Nonnull
        public Builder file(ActivationFile file) {
            this.file = file;
            return this;
        }

        @Nonnull
        public Builder packaging(String packaging) {
            this.packaging = packaging;
            return this;
        }


        @Nonnull
        public Builder location(Object key, InputLocation location) {
            if (location != null) {
                if (!(this.locations instanceof HashMap)) {
                    this.locations = this.locations != null ? new HashMap<>(this.locations) : new HashMap<>();
                }
                this.locations.put(key, location);
            }
            return this;
        }

        @Nonnull
        public Activation build() {
            if (base != null
                    && (activeByDefault == null || activeByDefault == base.activeByDefault)
                    && (jdk == null || jdk == base.jdk)
                    && (os == null || os == base.os)
                    && (property == null || property == base.property)
                    && (file == null || file == base.file)
                    && (packaging == null || packaging == base.packaging)
            ) {
                return base;
            }
            Map<Object, InputLocation> newlocs = this.locations != null ? this.locations : Collections.emptyMap();
            Map<Object, InputLocation> oldlocs = this.base != null && this.base.locations != null ? this.base.locations : Collections.emptyMap();
            Map<Object, InputLocation> locations = new HashMap<>();
            locations.put("", newlocs.containsKey("") ? newlocs.get("") : oldlocs.get(""));
            locations.put("activeByDefault", newlocs.containsKey("activeByDefault") ? newlocs.get("activeByDefault") : oldlocs.get("activeByDefault"));
            locations.put("jdk", newlocs.containsKey("jdk") ? newlocs.get("jdk") : oldlocs.get("jdk"));
            locations.put("os", newlocs.containsKey("os") ? newlocs.get("os") : oldlocs.get("os"));
            locations.put("property", newlocs.containsKey("property") ? newlocs.get("property") : oldlocs.get("property"));
            locations.put("file", newlocs.containsKey("file") ? newlocs.get("file") : oldlocs.get("file"));
            locations.put("packaging", newlocs.containsKey("packaging") ? newlocs.get("packaging") : oldlocs.get("packaging"));
            return new Activation(
                activeByDefault != null ? activeByDefault : (base != null ? base.activeByDefault : false),
                jdk != null ? jdk : (base != null ? base.jdk : null),
                os != null ? os : (base != null ? base.os : null),
                property != null ? property : (base != null ? base.property : null),
                file != null ? file : (base != null ? base.file : null),
                packaging != null ? packaging : (base != null ? base.packaging : null),
                locations
            );
        }
    }

}