This is an automated email from the ASF dual-hosted git repository. martin_s pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/archiva.git
commit 8a5703c6b21908d022ddcb0c620956f09caa47a9 Author: Martin Stockhammer <[email protected]> AuthorDate: Mon Feb 17 19:26:14 2020 +0100 Adding additonal javadoc --- .../archiva/repository/content/Namespace.java | 30 ++++++++++++++++++++++ .../apache/archiva/repository/content/Project.java | 20 +++++++++++---- 2 files changed, 45 insertions(+), 5 deletions(-) diff --git a/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Namespace.java b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Namespace.java index 4325584..d31aeed 100644 --- a/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Namespace.java +++ b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Namespace.java @@ -24,12 +24,42 @@ import java.util.List; * The namespace represents some kind of hierarchical coordinate where artifacts are stored. * The syntax of the namespace (e.g. the separator like '.' or '/') is dependent on the repository type. * + * <pre> + * namespace1 +--> project 1 +--> version 11 +--> artifact 111 + * | | | + * | | +--> artifact 112 + * | | + * | +--> version 12 +--> artifact 121 + * | | + * | +--> artifact 122 + * | +--> ... + * | + * +--> project 2 +--> version 21 +--> artifact 211 + * | +--> ... + * +--> version 22 +--> artifact 221 + * +--> ... + * </pre> + * * @author Martin Stockhammer <[email protected]> */ public interface Namespace extends ContentItem { + /** + * Return the namespace string that identifies the current namespace. + * Namespaces are hierarchical and have a separator that separates the path elements. Default + * separator is '.'. But this may depend on the repository type. + * + * A namespace may be empty which is equal to the root. + * + * @return the unique name of the namespace + */ String getNamespace( ); + /** + * Returns the elements that represent the path to the namespace. + * + * @return the list of path elements + */ List<String> getNamespacePath( ); } diff --git a/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Project.java b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Project.java index 4de6bad..b4b654f 100644 --- a/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Project.java +++ b/archiva-modules/archiva-base/archiva-repository-api/src/main/java/org/apache/archiva/repository/content/Project.java @@ -23,14 +23,24 @@ package org.apache.archiva.repository.content; * The project is the container for several versions each with different artifacts. * * <pre> - * project +--> version 1 + -> artifact 1 - * | | - * | + -> artifact 2 - * | - * +--> version 2 ----> artifact 3 + * namespace1 +--> project 1 +--> version 11 +--> artifact 111 + * | | | + * | | +--> artifact 112 + * | | + * | +--> version 12 +--> artifact 121 + * | | + * | +--> artifact 122 + * | +--> ... + * | + * +--> project 2 +--> version 21 +--> artifact 211 + * | +--> ... + * +--> version 22 +--> artifact 221 + * +--> ... * </pre> + * * <p> * Implementations must provide proper hash and equals methods. + * </p> * * @author Martin Stockhammer <[email protected]> */
