Introduce new LayoutLogMessageConstant class and move one log message there

DEVSIX-6175

Author: Snipx

io/src/main/java/com/itextpdf/io/logs/IoLogMessageConstant.java

@@ -183,6 +183,11 @@ public final class IoLogMessageConstant {
     public static final String DURING_CONSTRUCTION_OF_ICC_PROFILE_ERROR_OCCURRED = "During the construction of the ICC"
             + " profile, the {0} error with message \"{1}\" occurred, the ICC profile will not be installed in the "
             + "image.";
+
+    /**
+     * @deprecated Unused constant. Will be removed in 7.3
+     */
+    @Deprecated
     public static final String ELEMENT_DOES_NOT_FIT_AREA = "Element does not fit current area. {0}";
 
     public static final String ELEMENT_WAS_FORCE_PLACED_KEEP_WITH_NEXT_WILL_BE_IGNORED =

layout/src/main/java/com/itextpdf/layout/logs/LayoutLogMessageConstant.java

@@ -0,0 +1,13 @@
+package com.itextpdf.layout.logs;
+
+/**
+ * Class containing constants to be used in layout.
+ */
+public final class LayoutLogMessageConstant {
+
+    public static final String ELEMENT_DOES_NOT_FIT_AREA = "Element does not fit current area. {0}";
+
+    private LayoutLogMessageConstant() {
+        //Private constructor will prevent the instantiation of this class directly
+    }
+}

layout/src/main/java/com/itextpdf/layout/renderer/BlockRenderer.java

@@ -58,6 +58,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.layout.LayoutResult;
 import com.itextpdf.layout.layout.MinMaxWidthLayoutResult;
 import com.itextpdf.layout.layout.PositionedLayoutContext;
+import com.itextpdf.layout.logs.LayoutLogMessageConstant;
 import com.itextpdf.layout.margincollapse.MarginsCollapseHandler;
 import com.itextpdf.layout.margincollapse.MarginsCollapseInfo;
 import com.itextpdf.layout.minmaxwidth.MinMaxWidth;
@@ -446,7 +447,7 @@ public LayoutResult layout(LayoutContext layoutContext) {
             if (isNotFittingLayoutArea(layoutContext.getArea())) {
                 if (isNotFittingWidth(layoutContext.getArea()) && !isNotFittingHeight(layoutContext.getArea())) {
                     LoggerFactory.getLogger(getClass())
-                            .warn(MessageFormatUtil.format(IoLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA,
+                            .warn(MessageFormatUtil.format(LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA,
                                     "It fits by height so it will be forced placed"));
                 } else if (!Boolean.TRUE.equals(getPropertyAsBoolean(Property.FORCED_PLACEMENT))) {
                     floatRendererAreas.retainAll(nonChildFloatingRendererAreas);

layout/src/main/java/com/itextpdf/layout/renderer/ParagraphRenderer.java

@@ -43,7 +43,6 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.layout.renderer;
 
-import com.itextpdf.io.logs.IoLogMessageConstant;
 import com.itextpdf.commons.utils.MessageFormatUtil;
 import com.itextpdf.kernel.geom.Rectangle;
 import com.itextpdf.layout.borders.Border;
@@ -54,6 +53,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.layout.LineLayoutContext;
 import com.itextpdf.layout.layout.LineLayoutResult;
 import com.itextpdf.layout.layout.MinMaxWidthLayoutResult;
+import com.itextpdf.layout.logs.LayoutLogMessageConstant;
 import com.itextpdf.layout.margincollapse.MarginsCollapseHandler;
 import com.itextpdf.layout.minmaxwidth.MinMaxWidth;
 import com.itextpdf.layout.minmaxwidth.MinMaxWidthUtils;
@@ -484,7 +484,7 @@ protected LayoutResult directLayout(LayoutContext layoutContext) {
             if (isNotFittingLayoutArea(layoutContext.getArea())) {
                 if(isNotFittingWidth(layoutContext.getArea()) && !isNotFittingHeight(layoutContext.getArea())) {
                     LoggerFactory.getLogger(getClass())
-                            .warn(MessageFormatUtil.format(IoLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA,
+                            .warn(MessageFormatUtil.format(LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA,
                                     "It fits by height so it will be forced placed"));
                 } else if (!Boolean.TRUE.equals(getPropertyAsBoolean(Property.FORCED_PLACEMENT))) {
                     floatRendererAreas.retainAll(nonChildFloatingRendererAreas);

layout/src/main/java/com/itextpdf/layout/renderer/RootRenderer.java

@@ -57,6 +57,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.layout.LayoutResult;
 import com.itextpdf.layout.layout.PositionedLayoutContext;
 import com.itextpdf.layout.layout.RootLayoutArea;
+import com.itextpdf.layout.logs.LayoutLogMessageConstant;
 import com.itextpdf.layout.margincollapse.MarginsCollapseHandler;
 import com.itextpdf.layout.margincollapse.MarginsCollapseInfo;
 import com.itextpdf.layout.properties.ClearPropertyValue;
@@ -168,7 +169,7 @@ public void addChild(IRenderer renderer) {
                             ((ImageRenderer) result.getOverflowRenderer()).autoScale(currentArea);
                             result.getOverflowRenderer().setProperty(Property.FORCED_PLACEMENT, true);
                             Logger logger = LoggerFactory.getLogger(RootRenderer.class);
-                            logger.warn(MessageFormatUtil.format(IoLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA, ""));
+                            logger.warn(MessageFormatUtil.format(LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA, ""));
                         }
                     } else {
                         if (currentArea.isEmptyArea() && result.getAreaBreak() == null) {
@@ -499,7 +500,7 @@ private boolean updateForcedPlacement(IRenderer currentRenderer, IRenderer overf
             overflowRenderer.setProperty(Property.FORCED_PLACEMENT, true);
             Logger logger = LoggerFactory.getLogger(RootRenderer.class);
             if (logger.isWarnEnabled()) {
-                logger.warn(MessageFormatUtil.format(IoLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA, ""));
+                logger.warn(MessageFormatUtil.format(LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA, ""));
             }
             return true;
         }
@@ -530,7 +531,7 @@ private boolean tryDisableKeepTogether(LayoutResult result,
         Logger logger = LoggerFactory.getLogger(RootRenderer.class);
         if (logger.isWarnEnabled()) {
             logger.warn(MessageFormatUtil.format(
-                    IoLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA,
+                    LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA,
                     "KeepTogether property will be ignored."));
         }
         if (!rendererIsFloat) {

layout/src/test/java/com/itextpdf/layout/BorderTest.java

@@ -42,7 +42,6 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.layout;
 
-import com.itextpdf.io.logs.IoLogMessageConstant;
 import com.itextpdf.io.image.ImageDataFactory;
 import com.itextpdf.kernel.colors.ColorConstants;
 import com.itextpdf.kernel.colors.DeviceCmyk;
@@ -67,6 +66,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.element.List;
 import com.itextpdf.layout.element.ListItem;
 import com.itextpdf.layout.element.Paragraph;
+import com.itextpdf.layout.logs.LayoutLogMessageConstant;
 import com.itextpdf.test.ExtendedITextTest;
 import com.itextpdf.test.annotations.LogMessage;
 import com.itextpdf.test.annotations.LogMessages;
@@ -313,7 +313,7 @@ public void borderBoxTest() throws IOException, InterruptedException {
 
     @Test
     @LogMessages(messages = {
-            @LogMessage(messageTemplate = IoLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA, count = 1)
+            @LogMessage(messageTemplate = LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA, count = 1)
     })
     public void rotatedBordersTest() throws IOException, InterruptedException {
         fileName = "rotatedBordersTest.pdf";

layout/src/test/java/com/itextpdf/layout/DefaultLayoutTest.java

@@ -61,6 +61,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.element.AreaBreak;
 import com.itextpdf.layout.element.Paragraph;
 import com.itextpdf.layout.element.Text;
+import com.itextpdf.layout.logs.LayoutLogMessageConstant;
 import com.itextpdf.test.AssertUtil;
 import com.itextpdf.test.ExtendedITextTest;
 import com.itextpdf.test.LogLevelConstants;
@@ -188,7 +189,7 @@ public void textWithWhitespacesTest01() throws IOException, InterruptedException
 
     @Test
     @LogMessages(messages = {
-            @LogMessage(count = 1, messageTemplate = IoLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA)
+            @LogMessage(count = 1, messageTemplate = LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA)
     })
     public void addParagraphOnShortPage1() throws IOException, InterruptedException {
         String outFileName = destinationFolder + "addParagraphOnShortPage1.pdf";
@@ -213,7 +214,7 @@ public void addParagraphOnShortPage1() throws IOException, InterruptedException
 
     @Test
     @LogMessages(messages = {
-            @LogMessage(messageTemplate = IoLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA)
+            @LogMessage(messageTemplate = LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA)
     })
     public void addParagraphOnShortPage2() throws IOException, InterruptedException {
         String outFileName = destinationFolder + "addParagraphOnShortPage2.pdf";
@@ -234,7 +235,7 @@ public void addParagraphOnShortPage2() throws IOException, InterruptedException
 
     @Test
     @LogMessages(messages = {
-            @LogMessage(messageTemplate = IoLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA)
+            @LogMessage(messageTemplate = LayoutLogMessageConstant.ELEMENT_DOES_NOT_FIT_AREA)
     })
     public void addWordOnShortPageTest01() throws IOException, InterruptedException {
         String outFileName = destinationFolder + "addWordOnShortPageTest01.pdf";