// CHECKSTYLE_OFF: RegexpHeader
/**
 * This package contains non-functional annotations which are
 * used to tag various elements and help users understanding
 * how those types should be used.
 *
 * @since 4.0.0
 */
@Experimental

 not sure the unified source directory structure addresses this issue.

 Properties

 maven.user.config.dir (system,default=${user.home}/.m2)
 maven.home            (system,user,default=${user.home}/m2)
 maven.repo.local      (system,user,default=${maven.user.config.dir}/repository)

 We need to define what happens in the when things are not setup correctly

 o ~/.m2 directory does not exist

    </notifiers>
  </ciManagement>
  <mailingLists>
    <mailingList>
      <name>Maven User List</name>
      <subscribe>users******@****.***</subscribe>
      <unsubscribe>users******@****.***</unsubscribe>
      <post>users@maven.apache.org</post>
      <archive>http://mail-archives.apache.org/mod_mbox/maven-users</archive>
    </mailingList>
    <mailingList>
      <name>Maven Developer List</name>

    </mailingList>
    <mailingList>
      <name>Maven User List</name>
      <subscribe>users******@****.***</subscribe>
      <unsubscribe>users******@****.***</unsubscribe>
      <post>users@maven.apache.org</post>
      <archive>http://mail-archives.apache.org/mod_mbox/maven-users</archive>
      <otherArchives>
        <otherArchive>http://www.mail-archive.com/users@maven.apache.org/</otherArchive>

    </mailingList>
    <mailingList>
      <name>Maven User List</name>
      <subscribe>users******@****.***</subscribe>
      <unsubscribe>users******@****.***</unsubscribe>
      <post>users@maven.apache.org</post>
      <archive>http://mail-archives.apache.org/mod_mbox/maven-users</archive>
      <otherArchives>
        <otherArchive>http://www.mail-archive.com/users@maven.apache.org/</otherArchive>

    </mailingList>
    <mailingList>
      <name>Maven User List</name>
      <subscribe>users******@****.***</subscribe>
      <unsubscribe>users******@****.***</unsubscribe>
      <post>users@maven.apache.org</post>
      <archive>http://mail-archives.apache.org/mod_mbox/maven-users</archive>
      <otherArchives>
        <otherArchive>http://www.mail-archive.com/users@maven.apache.org/</otherArchive>

     */
    @Nonnull
    InputStream openStream() throws IOException;

    /**
     * Provides a user-friendly hint about the location of the source.
     * This could be a local file path, a URI or just an empty string.
     * The intention is to assist users during error reporting.
     *
     * @return a user-friendly hint about the location of the source, never {@code null}
     */
    @Nonnull
    String getLocation();

    pragmatic software license, and a desire to create high quality software that leads the way in its field.
    We consider ourselves not simply a group of projects sharing a server, but rather a community of developers
    and users.
  </description>
  <licenses>
    <license>
      <name>The Apache Software License, Version 2.0</name>
      <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
      <distribution>repo</distribution>

    public List<Proxy> getProxies() {
        if (proxies == null) {
            proxies = new ArrayList<>();
        }

        return proxies;
    }

    //
    // Used by Tycho and will break users and force them to upgrade to Maven 3.1 so we should really leave
    // this here, possibly indefinitely.
    //
    public ArtifactResolutionRequest setCache(RepositoryCache cache) {
        return this;
    }

     */
    InputStream getInputStream() throws IOException;

    /**
     * Provides a user-friendly hint about the location of the source. This could be a local file path, a URI or just an
     * empty string. The intention is to assist users during error reporting.
     *
     * @return A user-friendly hint about the location of the source, never {@code null}.
     */
    String getLocation();