UNOMI-186 improve deprecation marking
Project: http://git-wip-us.apache.org/repos/asf/incubator-unomi/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-unomi/commit/d9e9a8f4 Tree: http://git-wip-us.apache.org/repos/asf/incubator-unomi/tree/d9e9a8f4 Diff: http://git-wip-us.apache.org/repos/asf/incubator-unomi/diff/d9e9a8f4 Branch: refs/heads/master Commit: d9e9a8f49eab227930511d9cc8333a847968de0c Parents: d5d8450 Author: dgaillard <[email protected]> Authored: Fri Jun 29 12:11:34 2018 +0200 Committer: dgaillard <[email protected]> Committed: Fri Jun 29 12:11:34 2018 +0200 ---------------------------------------------------------------------- api/src/main/java/org/apache/unomi/api/Parameter.java | 5 ++++- .../org/apache/unomi/api/services/PersonalizationService.java | 1 + .../java/org/apache/unomi/api/services/PrivacyService.java | 7 +++++-- .../main/java/org/apache/unomi/api/services/QueryService.java | 1 + .../elasticsearch/ElasticSearchPersistenceServiceImpl.java | 5 ++++- .../org/apache/unomi/persistence/spi/PersistenceService.java | 1 + .../main/java/org/apache/unomi/rest/RulesServiceEndPoint.java | 1 + .../java/org/apache/unomi/rest/ScoringServiceEndPoint.java | 3 ++- .../java/org/apache/unomi/rest/SegmentServiceEndPoint.java | 1 + .../unomi/services/services/DefinitionsServiceImpl.java | 6 +++++- .../org/apache/unomi/services/services/QueryServiceImpl.java | 5 ++++- 11 files changed, 29 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/d9e9a8f4/api/src/main/java/org/apache/unomi/api/Parameter.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/unomi/api/Parameter.java b/api/src/main/java/org/apache/unomi/api/Parameter.java index c8a1f9e..c59fcab 100644 --- a/api/src/main/java/org/apache/unomi/api/Parameter.java +++ b/api/src/main/java/org/apache/unomi/api/Parameter.java @@ -47,7 +47,10 @@ public class Parameter implements Serializable { return multivalued; } - @Deprecated // As of version 1.1.0-incubating + /** + * @deprecated As of version 1.1.0-incubating + */ + @Deprecated public void setChoiceListInitializerFilter(String choiceListInitializerFilter) { // Avoid errors when deploying old definitions } http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/d9e9a8f4/api/src/main/java/org/apache/unomi/api/services/PersonalizationService.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/unomi/api/services/PersonalizationService.java b/api/src/main/java/org/apache/unomi/api/services/PersonalizationService.java index d8df08c..ad6e3a6 100644 --- a/api/src/main/java/org/apache/unomi/api/services/PersonalizationService.java +++ b/api/src/main/java/org/apache/unomi/api/services/PersonalizationService.java @@ -133,6 +133,7 @@ public interface PersonalizationService { * @param filterid the filter identifier associated with this content filtering definition * @deprecated As of version 1.3.0-incubating, please use {@link #setId(String)} instead */ + @Deprecated public void setFilterid(String filterid) { this.id = filterid; } http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/d9e9a8f4/api/src/main/java/org/apache/unomi/api/services/PrivacyService.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/unomi/api/services/PrivacyService.java b/api/src/main/java/org/apache/unomi/api/services/PrivacyService.java index 4b67caf..d860b7c 100644 --- a/api/src/main/java/org/apache/unomi/api/services/PrivacyService.java +++ b/api/src/main/java/org/apache/unomi/api/services/PrivacyService.java @@ -149,23 +149,26 @@ public interface PrivacyService { * @deprecated As of version 1.3.0-incubating, do not use this method, instead mark properties with the personal identifier tag which * will mark them as denied by the getDeniedProperties method */ + @Deprecated Boolean setDeniedProperties(String profileId, List<String> propertyNames); /** * This method doesn't do anything anymore please don't use it - * @deprecated As of version 1.3.0-incubating, do not use this method * @param profileId the identifier of the profile * @return do not use + * @deprecated As of version 1.3.0-incubating, do not use this method */ + @Deprecated List<String> getDeniedPropertyDistribution(String profileId); /** * This method doesn't do anything anymore please don't use it - * @deprecated As of version 1.3.0-incubating, do not use this method * @param profileId the identifier of the profile * @param propertyNames do not use * @return do not use + * @deprecated As of version 1.3.0-incubating, do not use this method */ + @Deprecated Boolean setDeniedPropertyDistribution(String profileId, List<String> propertyNames); /** http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/d9e9a8f4/api/src/main/java/org/apache/unomi/api/services/QueryService.java ---------------------------------------------------------------------- diff --git a/api/src/main/java/org/apache/unomi/api/services/QueryService.java b/api/src/main/java/org/apache/unomi/api/services/QueryService.java index 208277b..c397fda 100644 --- a/api/src/main/java/org/apache/unomi/api/services/QueryService.java +++ b/api/src/main/java/org/apache/unomi/api/services/QueryService.java @@ -53,6 +53,7 @@ public interface QueryService { * @see Item Item for a discussion of {@code ITEM_TYPE} * @deprecated As of 1.3.0-incubating, please use {@link #getAggregateWithOptimizedQuery(String, String, AggregateQuery)} instead */ + @Deprecated Map<String, Long> getAggregate(String itemType, String property, AggregateQuery query); /** http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/d9e9a8f4/persistence-elasticsearch/core/src/main/java/org/apache/unomi/persistence/elasticsearch/ElasticSearchPersistenceServiceImpl.java ---------------------------------------------------------------------- diff --git a/persistence-elasticsearch/core/src/main/java/org/apache/unomi/persistence/elasticsearch/ElasticSearchPersistenceServiceImpl.java b/persistence-elasticsearch/core/src/main/java/org/apache/unomi/persistence/elasticsearch/ElasticSearchPersistenceServiceImpl.java index e63f928..def798f 100644 --- a/persistence-elasticsearch/core/src/main/java/org/apache/unomi/persistence/elasticsearch/ElasticSearchPersistenceServiceImpl.java +++ b/persistence-elasticsearch/core/src/main/java/org/apache/unomi/persistence/elasticsearch/ElasticSearchPersistenceServiceImpl.java @@ -1481,7 +1481,10 @@ public class ElasticSearchPersistenceServiceImpl implements PersistenceService, }.catchingExecuteInClassLoader(true); } - @Deprecated // As of version 1.3.0-incubating + /** + * @deprecated As of version 1.3.0-incubating, use {@link #aggregateWithOptimizedQuery(Condition, BaseAggregate, String)} instead + */ + @Deprecated @Override public Map<String, Long> aggregateQuery(Condition filter, BaseAggregate aggregate, String itemType) { return aggregateQuery(filter, aggregate, itemType, false); http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/d9e9a8f4/persistence-spi/src/main/java/org/apache/unomi/persistence/spi/PersistenceService.java ---------------------------------------------------------------------- diff --git a/persistence-spi/src/main/java/org/apache/unomi/persistence/spi/PersistenceService.java b/persistence-spi/src/main/java/org/apache/unomi/persistence/spi/PersistenceService.java index 1b673be..ede120d 100644 --- a/persistence-spi/src/main/java/org/apache/unomi/persistence/spi/PersistenceService.java +++ b/persistence-spi/src/main/java/org/apache/unomi/persistence/spi/PersistenceService.java @@ -421,6 +421,7 @@ public interface PersistenceService { * @return a Map associating aggregation dimension name as key and cardinality for that dimension as value * @deprecated As of 1.3.0-incubating, please use {@link #aggregateWithOptimizedQuery(Condition, BaseAggregate, String)} instead */ + @Deprecated Map<String, Long> aggregateQuery(Condition filter, BaseAggregate aggregate, String itemType); /** http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/d9e9a8f4/rest/src/main/java/org/apache/unomi/rest/RulesServiceEndPoint.java ---------------------------------------------------------------------- diff --git a/rest/src/main/java/org/apache/unomi/rest/RulesServiceEndPoint.java b/rest/src/main/java/org/apache/unomi/rest/RulesServiceEndPoint.java index 1e7e37c..f27a95e 100644 --- a/rest/src/main/java/org/apache/unomi/rest/RulesServiceEndPoint.java +++ b/rest/src/main/java/org/apache/unomi/rest/RulesServiceEndPoint.java @@ -165,6 +165,7 @@ public class RulesServiceEndPoint { * * @deprecated As of version 1.1.0-incubating, not needed anymore */ + @Deprecated @GET @Path("/resetQueries") public void resetQueries() { http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/d9e9a8f4/rest/src/main/java/org/apache/unomi/rest/ScoringServiceEndPoint.java ---------------------------------------------------------------------- diff --git a/rest/src/main/java/org/apache/unomi/rest/ScoringServiceEndPoint.java b/rest/src/main/java/org/apache/unomi/rest/ScoringServiceEndPoint.java index 6001c97..599a42f 100644 --- a/rest/src/main/java/org/apache/unomi/rest/ScoringServiceEndPoint.java +++ b/rest/src/main/java/org/apache/unomi/rest/ScoringServiceEndPoint.java @@ -131,7 +131,7 @@ public class ScoringServiceEndPoint { * @param validate whether or not to perform validation * @return a list of impacted items metadata if any or an empty list if none were found or validation was skipped */ - @DELETE + @DELETE @Path("/{scoringID}") public DependentMetadata removeScoringDefinition(@PathParam("scoringID") String scoringId, @QueryParam("validate") boolean validate) { return segmentService.removeScoringDefinition(scoringId, validate); @@ -155,6 +155,7 @@ public class ScoringServiceEndPoint { * * @deprecated As of version 1.1.0-incubating, not needed anymore */ + @Deprecated @GET @Path("/resetQueries") public void resetQueries() { http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/d9e9a8f4/rest/src/main/java/org/apache/unomi/rest/SegmentServiceEndPoint.java ---------------------------------------------------------------------- diff --git a/rest/src/main/java/org/apache/unomi/rest/SegmentServiceEndPoint.java b/rest/src/main/java/org/apache/unomi/rest/SegmentServiceEndPoint.java index 33da462..5d0e09c 100644 --- a/rest/src/main/java/org/apache/unomi/rest/SegmentServiceEndPoint.java +++ b/rest/src/main/java/org/apache/unomi/rest/SegmentServiceEndPoint.java @@ -183,6 +183,7 @@ public class SegmentServiceEndPoint { * * @deprecated As of version 1.1.0-incubating, not needed anymore */ + @Deprecated @GET @Path("/resetQueries") public void resetQueries() { http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/d9e9a8f4/services/src/main/java/org/apache/unomi/services/services/DefinitionsServiceImpl.java ---------------------------------------------------------------------- diff --git a/services/src/main/java/org/apache/unomi/services/services/DefinitionsServiceImpl.java b/services/src/main/java/org/apache/unomi/services/services/DefinitionsServiceImpl.java index 62be8bb..eacd270 100644 --- a/services/src/main/java/org/apache/unomi/services/services/DefinitionsServiceImpl.java +++ b/services/src/main/java/org/apache/unomi/services/services/DefinitionsServiceImpl.java @@ -26,6 +26,7 @@ import org.apache.unomi.api.conditions.ConditionType; import org.apache.unomi.api.services.DefinitionsService; import org.apache.unomi.persistence.spi.CustomObjectMapper; import org.apache.unomi.persistence.spi.PersistenceService; +import org.apache.unomi.persistence.spi.aggregate.BaseAggregate; import org.osgi.framework.Bundle; import org.osgi.framework.BundleContext; import org.osgi.framework.BundleEvent; @@ -379,7 +380,10 @@ public class DefinitionsServiceImpl implements DefinitionsService, SynchronousBu } } - @Deprecated // As of version 1.2.0-incubating + /** + * @deprecated As of version 1.2.0-incubating, use {@link #extractConditionBySystemTag(Condition, String)} instead + */ + @Deprecated public Condition extractConditionByTag(Condition rootCondition, String tag) { if (rootCondition.containsParameter("subConditions")) { @SuppressWarnings("unchecked") http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/d9e9a8f4/services/src/main/java/org/apache/unomi/services/services/QueryServiceImpl.java ---------------------------------------------------------------------- diff --git a/services/src/main/java/org/apache/unomi/services/services/QueryServiceImpl.java b/services/src/main/java/org/apache/unomi/services/services/QueryServiceImpl.java index d5aa81a..e03ddb2 100644 --- a/services/src/main/java/org/apache/unomi/services/services/QueryServiceImpl.java +++ b/services/src/main/java/org/apache/unomi/services/services/QueryServiceImpl.java @@ -56,7 +56,10 @@ public class QueryServiceImpl implements QueryService { return persistenceService.aggregateWithOptimizedQuery(null, new TermsAggregate(property), itemType); } - @Deprecated // As of version 1.3.0-incubating + /** + * @deprecated As of version 1.3.0-incubating, use {@link #getAggregateWithOptimizedQuery(String, String, AggregateQuery)} instead + */ + @Deprecated @Override public Map<String, Long> getAggregate(String itemType, String property, AggregateQuery query) { return getAggregate(itemType, property, query, false);
