Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPascal Rapicault2010-03-11 19:45:12 -0500
committerPascal Rapicault2010-03-11 19:45:12 -0500
commit04dfebbcd43b8facc4029e49952250546770d311 (patch)
tree51aa10b093ff3a56375497038add8e39c6621434 /bundles/org.eclipse.equinox.p2.repository
parent0e64148bb2966c8d6186ce614f19e4ad21bbdd9b (diff)
downloadrt.equinox.p2-04dfebbcd43b8facc4029e49952250546770d311.tar.gz
rt.equinox.p2-04dfebbcd43b8facc4029e49952250546770d311.tar.xz
rt.equinox.p2-04dfebbcd43b8facc4029e49952250546770d311.zip
Java doc tweaks (@noextend, @noimplement, final, etc)
Diffstat (limited to 'bundles/org.eclipse.equinox.p2.repository')
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java2
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepository.java3
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepositoryManager.java1
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepositoryReference.java2
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/ArtifactDescriptorQuery.java2
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/ArtifactKeyQuery.java2
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactDescriptor.java3
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepository.java3
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepositoryManager.java1
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IFileArtifactRepository.java2
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IProcessingStepDescriptor.java4
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/metadata/IMetadataRepository.java2
-rw-r--r--bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/metadata/IMetadataRepositoryManager.java1
13 files changed, 23 insertions, 5 deletions
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java
index ed9abff1d..44e699962 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java
@@ -24,6 +24,8 @@ import org.eclipse.equinox.p2.metadata.IInstallableUnit;
* of its children.
* @param <T> The type of repository content. Typically this is either {@link IInstallableUnit}
* or {@link IArtifactKey}.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
* @since 2.0
*/
public interface ICompositeRepository<T> extends IRepository<T> {
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepository.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepository.java
index dd5c01f67..35a722aa7 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepository.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepository.java
@@ -22,7 +22,8 @@ import org.eclipse.equinox.p2.query.IQueryable;
* of repositories.
* @param <T> The type of contents contained in this repository
*
- * @noimplement This interface is not intended to be implemented by clients.
+ * @noimplement This interface is not intended to be implemented by clients. Instead the abstract classes implementing this interface should be used.
+ * @noextend This interface is not intended to be extended by clients.
* @since 2.0
*/
public interface IRepository<T> extends IAdaptable, IQueryable<T> {
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepositoryManager.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepositoryManager.java
index fd65f00ed..2cb3d22ff 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepositoryManager.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepositoryManager.java
@@ -26,6 +26,7 @@ import org.eclipse.equinox.p2.query.IQueryable;
* </p>
* @param <T> the type of contents in the repositories controlled by this manager
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
* @since 2.0
*/
public interface IRepositoryManager<T> extends IQueryable<T> {
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepositoryReference.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepositoryReference.java
index cefafb71f..346cf4956 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepositoryReference.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/IRepositoryReference.java
@@ -14,6 +14,8 @@ package org.eclipse.equinox.p2.repository;
import java.net.URI;
/**
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients. Instead clients should use one of the class implementing this interface.
* @since 2.0
*/
public interface IRepositoryReference {
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/ArtifactDescriptorQuery.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/ArtifactDescriptorQuery.java
index 26e096645..778e9f5aa 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/ArtifactDescriptorQuery.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/ArtifactDescriptorQuery.java
@@ -25,7 +25,7 @@ import org.eclipse.equinox.p2.query.ExpressionMatchQuery;
*
* @since 2.0
*/
-public class ArtifactDescriptorQuery extends ExpressionMatchQuery<IArtifactDescriptor> {
+public final class ArtifactDescriptorQuery extends ExpressionMatchQuery<IArtifactDescriptor> {
private static final IExpression descriptorMatch = ExpressionUtil.parse(//
"artifactKey.id == $0 && artifactKey.version ~= $1 && ($2.empty || $2.all(x | properties[x.key] == x.value))"); //$NON-NLS-1$
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/ArtifactKeyQuery.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/ArtifactKeyQuery.java
index 596257f5d..1e8f0ade9 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/ArtifactKeyQuery.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/ArtifactKeyQuery.java
@@ -25,7 +25,7 @@ import org.eclipse.equinox.p2.query.IQueryable;
*
* @since 2.0
*/
-public class ArtifactKeyQuery extends ExpressionMatchQuery<IArtifactKey> {
+public final class ArtifactKeyQuery extends ExpressionMatchQuery<IArtifactKey> {
private static final IExpression matchKey = ExpressionUtil.parse("this == $0"); //$NON-NLS-1$
private static final IExpression matchID = ExpressionUtil.parse("id == $0"); //$NON-NLS-1$
private static final IExpression matchIDClassifierRange = ExpressionUtil.parse("id == $0 && version ~= $2 && (null == $1 || classifier == $1)"); //$NON-NLS-1$
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactDescriptor.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactDescriptor.java
index 4d64628d3..db3c2ebde 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactDescriptor.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactDescriptor.java
@@ -12,6 +12,7 @@ package org.eclipse.equinox.p2.repository.artifact;
import java.util.Map;
import org.eclipse.equinox.p2.metadata.IArtifactKey;
+import org.eclipse.equinox.p2.repository.artifact.spi.ArtifactDescriptor;
/**
* An artifact descriptor describes an artifact stored in some artifact repository. The
@@ -19,6 +20,8 @@ import org.eclipse.equinox.p2.metadata.IArtifactKey;
* must be performed when the artifact is transferred out of the repository (such
* as decompression, error checking, etc).
*
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients. Instead subclass the {@link ArtifactDescriptor} class
* @since 2.0
*/
public interface IArtifactDescriptor {
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepository.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepository.java
index 03cbafb96..ae46654d5 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepository.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepository.java
@@ -28,7 +28,8 @@ import org.eclipse.equinox.p2.repository.artifact.spi.AbstractArtifactRepository
* implementations must subclass {@link AbstractArtifactRepository} rather than
* implementing this interface directly.
* </p>
- * @noimplement This interface is not intended to be implemented by clients.
+ * @noimplement This interface is not intended to be implemented by clients. Instead subclass {@link AbstractArtifactRepository}.
+ * @noextend This interface is not intended to be extended by clients.
* @since 2.0
*/
public interface IArtifactRepository extends IRepository<IArtifactKey> {
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepositoryManager.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepositoryManager.java
index 1ebda19e9..45d2a549d 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepositoryManager.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IArtifactRepositoryManager.java
@@ -23,6 +23,7 @@ import org.eclipse.equinox.p2.repository.IRepositoryManager;
* for a general description of the characteristics of repository managers.
*
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
* @since 2.0
*/
public interface IArtifactRepositoryManager extends IRepositoryManager<IArtifactKey> {
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IFileArtifactRepository.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IFileArtifactRepository.java
index bc1561595..032d1018e 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IFileArtifactRepository.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IFileArtifactRepository.java
@@ -15,6 +15,8 @@ import org.eclipse.equinox.p2.metadata.IArtifactKey;
/**
* An artifact repository whose artifacts are available in the local file system.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
* @since 2.0
*/
public interface IFileArtifactRepository extends IArtifactRepository {
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IProcessingStepDescriptor.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IProcessingStepDescriptor.java
index f24d48591..53b2fc1bb 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IProcessingStepDescriptor.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/artifact/IProcessingStepDescriptor.java
@@ -9,6 +9,8 @@
******************************************************************************/
package org.eclipse.equinox.p2.repository.artifact;
+import org.eclipse.equinox.p2.repository.artifact.spi.ProcessingStepDescriptor;
+
/**
* Describes a processing step. Processing steps are pieces of code that participate
* in the the transfer of an artifact between artifact repositories. A step may alter
@@ -16,6 +18,8 @@ package org.eclipse.equinox.p2.repository.artifact;
* compression), or it may perform additional checks on the transferred bytes such as
* checksums or signature verification.
*
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients. Instead subclass the {@link ProcessingStepDescriptor}.
* @see IArtifactDescriptor#getProcessingSteps()
* @since 2.0
*/
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/metadata/IMetadataRepository.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/metadata/IMetadataRepository.java
index af4f5fdd2..e6633c37f 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/metadata/IMetadataRepository.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/metadata/IMetadataRepository.java
@@ -24,7 +24,7 @@ import org.eclipse.equinox.p2.repository.metadata.spi.AbstractMetadataRepository
* implementations must subclass {@link AbstractMetadataRepository} rather than
* implementing this interface directly.
* </p>
- * @noimplement This interface is not intended to be implemented by clients.
+ * @noimplement This interface is not intended to be implemented by clients. Instead subclass {@link AbstractMetadataRepository}
* @since 2.0
*/
public interface IMetadataRepository extends IRepository<IInstallableUnit> {
diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/metadata/IMetadataRepositoryManager.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/metadata/IMetadataRepositoryManager.java
index 56458b8eb..7e7651507 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/metadata/IMetadataRepositoryManager.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/metadata/IMetadataRepositoryManager.java
@@ -24,6 +24,7 @@ import org.eclipse.equinox.p2.repository.IRepositoryManager;
* for a general description of the characteristics of repository managers.
*
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
* @since 2.0
*/
public interface IMetadataRepositoryManager extends IRepositoryManager<IInstallableUnit> {

Back to the top