[java-metadata-aggregator COMMIT] in /trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query: Entit...

noreply at shibboleth.net noreply at shibboleth.net
Fri Feb 21 09:26:21 EST 2014


Author: iay
Date: Fri Feb 21 09:26:21 2014
New Revision: 345

URL: http://svn.shibboleth.net/view/java-metadata-aggregator?rev=345&view=rev
Log:
Javadoc fixes.

Modified:
    trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/EntityIdTransformStage.java
    trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/MetadataSerializerViewAdapter.java
    trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/QueryController.java

Modified: trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/EntityIdTransformStage.java
URL: http://svn.shibboleth.net/view/java-metadata-aggregator/trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/EntityIdTransformStage.java?rev=345&r1=344&r2=345&view=diff
==============================================================================
--- trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/EntityIdTransformStage.java (original)
+++ trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/EntityIdTransformStage.java Fri Feb 21 09:26:21 2014
@@ -40,8 +40,8 @@
 import edu.vt.middleware.crypt.util.HexConverter;
 
 /**
- * A pipeline stage that, if present, takes each {@link EntityIdInfo} associated with a metadata element, transforms it
- * value using a set of registered transformers, and associates an additional {@link EntityIdInfo} (whose value is the
+ * A pipeline stage that, if present, takes each {@link ItemId} associated with a metadata element, transforms it
+ * value using a set of registered transformers, and associates an additional {@link ItemId} (whose value is the
  * result of the transform) with the element.
  * 
  * @param <T> type of metadata this stage operates upon

Modified: trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/MetadataSerializerViewAdapter.java
URL: http://svn.shibboleth.net/view/java-metadata-aggregator/trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/MetadataSerializerViewAdapter.java?rev=345&r1=344&r2=345&view=diff
==============================================================================
--- trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/MetadataSerializerViewAdapter.java (original)
+++ trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/MetadataSerializerViewAdapter.java Fri Feb 21 09:26:21 2014
@@ -37,6 +37,8 @@
 
 /**
  * Adapts an {@link ItemSerializer} to a Spring {@link View}.
+ * 
+ * @param <T> type of metadata this stage operates upon
  */
 public class MetadataSerializerViewAdapter<T> implements View {
 
@@ -46,7 +48,7 @@
     /** Media type handled by this view. */
     private MediaType mediaType;
 
-    /** Serializer used to serialize a {@link MetadataCollection} to an {@link OutputStream}. */
+    /** Serializer used to serialize a {@link Collection} of {@link Item}s to an {@link OutputStream}. */
     private ItemSerializer<T> serializer;
 
     /**

Modified: trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/QueryController.java
URL: http://svn.shibboleth.net/view/java-metadata-aggregator/trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/QueryController.java?rev=345&r1=344&r2=345&view=diff
==============================================================================
--- trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/QueryController.java (original)
+++ trunk/aggregator-web-service/src/main/java/net/shibboleth/metadata/query/QueryController.java Fri Feb 21 09:26:21 2014
@@ -55,7 +55,7 @@
 /**
  * Controller that responds to Metadata Query requests.
  * 
- * @param <T> type of metadata this stage operates upon
+ * @param <T> type of metadata this controller operates upon
  */
 @Controller
 public class QueryController<T> {
@@ -133,7 +133,6 @@
      * @throws PipelineProcessingException thrown if there is a problem running a query result set through a
      *             post-processing pipeline
      */
-    @SuppressWarnings({ "unchecked", "rawtypes" })
     @RequestMapping(value = "/entities", method = RequestMethod.GET)
     @ModelAttribute(METADATA_MODEL_ATTRIB)
     public Collection<Item<T>> queryMetadata(final HttpServletRequest request) throws PipelineProcessingException {
@@ -245,12 +244,12 @@
     }
 
     /**
-     * Checks if the given search term matches any {@link EntityIdInfo} for the given metadata element.
+     * Checks if the given search term matches any {@link ItemId} for the given metadata element.
      * 
      * @param searchTerm search term to check
-     * @param element element whose {@link EntityIdInfo} will be checked
-     * 
-     * @return true if the search term matched any {@link EntityIdInfo} for the given element, false otherwise
+     * @param element element whose {@link ItemId} will be checked
+     * 
+     * @return true if the search term matched any {@link ItemId} for the given element, false otherwise
      */
     protected boolean isEntityId(final String searchTerm, final Item<T> element) {

[... 38 lines stripped ...]


More information about the commits mailing list