2.2

Author: dxa-team

dxa-framework/dxa-tridion-provider/src/main/java/com/sdl/dxa/tridion/mapping/EntityModelBuilder.java

@@ -19,11 +19,13 @@ public interface EntityModelBuilder extends ModelBuilder {
     /**
      * Builds a strongly typed Entity Model based on a given DXA R2 Data Model. Never returns {@code null}.
      *
+     * @param <T> The expected class of the value.
      * @param originalEntityModel the strongly typed {@linkplain EntityModel Entity Model} to build.
      *                            Is {@code null} for the first {@linkplain EntityModelBuilder Entity Model Builder} in the {@link ModelBuilderPipelineImpl}
      * @param modelData           the DXA R2 Data Model
      * @param expectedClass       required class of entity model, gets the priority if {@code modelData} contains {@linkplain MvcModelData MVC} data
      * @return the strongly typed Entity Model
+     * @throws DxaException Thrown when building of model fails
      */
     @Contract("_, _, _ -> !null")
     <T extends EntityModel> T buildEntityModel(@Nullable T originalEntityModel, EntityModelData modelData,

dxa-framework/dxa-tridion-provider/src/main/java/com/sdl/dxa/tridion/mapping/ModelBuilderPipeline.java

@@ -18,6 +18,7 @@ public interface ModelBuilderPipeline {
     /**
      * See {@link PageModelBuilder#buildPageModel(PageModel, PageModelData)}.
      *
+     * @param modelData model data
      * @return Page Model or {@code null} if no builders are registered
      */
     @NotNull
@@ -27,16 +28,21 @@ public interface ModelBuilderPipeline {
      * See {@link EntityModelBuilder#buildEntityModel(EntityModel, EntityModelData, Class)}.
      * {@code expectedClass} defaults to data from {@code MvcData}
      *
+     * @param modelData model data
      * @return Entity Model or {@code null} if no builders are registered
+     * @throws DxaException in case
      */
     @NotNull
     <T extends EntityModel> T createEntityModel(@NotNull EntityModelData modelData) throws DxaException;
 
     /**
      * See {@link EntityModelBuilder#buildEntityModel(EntityModel, EntityModelData, Class)}.
      *
+     * @param <T> type that extends EntityModel
+     * @param modelData model data
+     * @param expectedClass expected class
      * @return Entity Model
-     * @throws IllegalArgumentException in case
+     * @throws DxaException in case
      */
     @NotNull
     <T extends EntityModel> T createEntityModel(@NotNull EntityModelData modelData, @Nullable Class<T> expectedClass) throws DxaException;

dxa-framework/dxa-tridion-provider/src/main/java/com/sdl/dxa/tridion/mapping/PageModelBuilder.java

@@ -21,6 +21,7 @@ public interface PageModelBuilder extends ModelBuilder {
      *                          Is {@code null} for the first {@linkplain PageModelBuilder Page Model Builder} in the {@link ModelBuilderPipelineImpl}
      * @param modelData         the DXA R2 Data Model
      * @return the strongly typed Page Model, or {@code null} if cannot build a page
+     * @throws SemanticMappingException in case of issue during semantic mapping
      */
     @Nullable
     PageModel buildPageModel(@Nullable PageModel originalPageModel, PageModelData modelData) throws SemanticMappingException;

dxa-framework/dxa-tridion-provider/src/main/java/com/sdl/dxa/tridion/mapping/impl/AbstractContentProvider.java

@@ -43,12 +43,12 @@ public void setEntityEvaluators(List<ConditionalEntityEvaluator> entityEvaluator
 
     /**
      * This default implementation handles caching and cloning the pagemodel.
-     * Actually getting the pagemodel from the backend is done in loadPage.
+     * Actually getting the page model from the backend is done in loadPage.
      *
-     * @param path
-     * @param localization
-     * @return
-     * @throws ContentProviderException
+     * @param path path
+     * @param localization Localization object
+     * @return page model
+     * @throws ContentProviderException in case of bad request
      */
     public PageModel getPageModel(String path, Localization localization) throws ContentProviderException {
         Assert.notNull(localization);
@@ -100,10 +100,10 @@ public PageModel getPageModel(String path, Localization localization) throws Con
      * This default implementation handles caching and cloning the pagemodel.
      * Actually getting the pagemodel from the backend is done in loadPage.
      *
-     * @param pageId
-     * @param localization
-     * @return
-     * @throws ContentProviderException
+     * @param pageId page ID
+     * @param localization Localization object
+     * @return page model
+     * @throws ContentProviderException in case of bad request
      */
     public PageModel getPageModel(int pageId, Localization localization) throws ContentProviderException {
         Assert.notNull(localization);
@@ -153,7 +153,7 @@ public PageModel getPageModel(int pageId, Localization localization) throws Cont
 
     /**
      * Create a cache key for the current claims.
-     * @return
+     * @return cache key
      */
     private String getClaimCacheKey() {
         ClaimStore currentClaimStore = WebContext.getCurrentClaimStore();

dxa-framework/dxa-tridion-provider/src/main/java/com/sdl/dxa/tridion/mapping/impl/StronglyTypedTopicBuilder.java

@@ -100,9 +100,11 @@ public StronglyTypedTopicBuilder() throws XPathExpressionException {
     /**
      * Tries to convert a given generic Topic to a Strongly Typed Topic Model.
      *
+     * @param <T> entity model type
      * @param genericTopic The generic Topic to convert.
      * @param ofType The type of the Strongly Typed Topic Model to convert to. If not specified (or null), the type will be determined from the XHTML.
-     * @returns The Strongly Typed Topic Model or null if the generic Topic cannot be converted.
+     * @return The Strongly Typed Topic Model or null if the generic Topic cannot be converted.
+     * @throws DxaException in case of error during conversion
      */
     public <T extends EntityModel> T tryConvertToStronglyTypedTopic(GenericTopic genericTopic, Class<T> ofType) throws DxaException {
         LOG.debug("Trying to convert {} to Strongly Typed Topic Model...", genericTopic);
@@ -235,10 +237,14 @@ protected String getPropertyXPath(String propertyName) {
     }
 
     /**
-    * Filters the XHTML elements found by the XPath query.
+     * Filters the XHTML elements found by the XPath query.
      *
-    * Because we use "contains" in the XPath, it may match on part of a class name.
-    * We filter out any partial matches here.
+     * Because we use "contains" in the XPath, it may match on part of a class name.
+     * We filter out any partial matches here.
+     *
+     * @param htmlNodes list of html nodes
+     * @param ditaPropertyName property name
+     * @return List of filtered elements
      */
     protected List<Element> filterXPathResults(NodeList htmlNodes, String ditaPropertyName) {
         if (htmlNodes == null || htmlNodes.getLength() == 0)
@@ -472,8 +478,12 @@ protected Link buildLink(Element htmlElement) {
     /**
      * Builds a strongly typed Entity Model based on a given DXA R2 Data Model.
      *
+     * @param <T> entity model type
      * @param entityModel The strongly typed Entity Model to build. Is null for the first Entity Model Builder in the pipeline.
      * @param entityModelData The DXA R2 Data Model.
+     * @param expectedClass expected class.
+     * @return entity model
+     * @throws DxaException in case of error during conversion
      */
     @Override
     public <T extends EntityModel> T buildEntityModel(@Nullable T entityModel, EntityModelData entityModelData, @Nullable Class<T> expectedClass) throws DxaException {