r4fterman/pdf.forms

View on GitHub
src/main/java/org/pdf/forms/writer/PdfTextFieldWriter.java

Summary

Maintainability
C
1 day
Test Coverage
F
0%

Method writeOutCaption has 32 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private void writeOutCaption(
            final IWidget widget,
            final Rectangle pageSize,
            final int currentPage,
            final GlobalPdfWriter globalPdfWriter) {
Severity: Minor
Found in src/main/java/org/pdf/forms/writer/PdfTextFieldWriter.java - About 1 hr to fix

    Method write has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

                final IWidget widget,
                final Rectangle pageSize,
                final int currentPage,
                final PdfWriter writer,
                final GlobalPdfWriter globalPdfWriter) throws IOException, DocumentException {
    Severity: Minor
    Found in src/main/java/org/pdf/forms/writer/PdfTextFieldWriter.java - About 35 mins to fix

      This block of commented-out lines of code should be removed.
      Open

              //BaseFont bf = valueFontToUse.getCalculatedBaseFont(false);

      Programmers should not comment out code as it bloats programs and reduces readability.

      Unused code should be deleted and can be retrieved from source control history if required.

      This block of commented-out lines of code should be removed.
      Open

              //Graphics2D graphics2D = cb.createGraphicsShapes(captionBounds.width, captionBounds.height, true, 0.95f);

      Programmers should not comment out code as it bloats programs and reduces readability.

      Unused code should be deleted and can be retrieved from source control history if required.

      Remove this unused private "addJavaScriptToFormField" method.
      Open

          private void addJavaScriptToFormField(

      private methods that are never executed are dead code: unnecessary, inoperative code that should be removed. Cleaning out dead code decreases the size of the maintained codebase, making it easier to understand the program and preventing bugs from being introduced.

      Note that this rule does not take reflection into account, which means that issues will be raised on private methods that are only accessed using the reflection API.

      Noncompliant Code Example

      public class Foo implements Serializable
      {
        private Foo(){}     //Compliant, private empty constructor intentionally used to prevent any direct instantiation of a class.
        public static void doSomething(){
          Foo foo = new Foo();
          ...
        }
        private void unusedPrivateMethod(){...}
        private void writeObject(ObjectOutputStream s){...}  //Compliant, relates to the java serialization mechanism
        private void readObject(ObjectInputStream in){...}  //Compliant, relates to the java serialization mechanism
      }
      

      Compliant Solution

      public class Foo implements Serializable
      {
        private Foo(){}     //Compliant, private empty constructor intentionally used to prevent any direct instantiation of a class.
        public static void doSomething(){
          Foo foo = new Foo();
          ...
        }
      
        private void writeObject(ObjectOutputStream s){...}  //Compliant, relates to the java serialization mechanism
      
        private void readObject(ObjectInputStream in){...}  //Compliant, relates to the java serialization mechanism
      }
      

      Exceptions

      This rule doesn't raise any issue on annotated methods.

      This block of commented-out lines of code should be removed.
      Open

              // tf.setBorderStyle(PdfBorderDictionary.STYLE_INSET);

      Programmers should not comment out code as it bloats programs and reduces readability.

      Unused code should be deleted and can be retrieved from source control history if required.

      This block of commented-out lines of code should be removed.
      Open

              //PdfCaption textFieldCaption = widget.getCaptionComponent();

      Programmers should not comment out code as it bloats programs and reduces readability.

      Unused code should be deleted and can be retrieved from source control history if required.

      Identical blocks of code found in 3 locations. Consider refactoring.
      Open

          private void writeOutCaption(
                  final IWidget widget,
                  final Rectangle pageSize,
                  final int currentPage,
                  final GlobalPdfWriter globalPdfWriter) {
      Severity: Major
      Found in src/main/java/org/pdf/forms/writer/PdfTextFieldWriter.java and 2 other locations - About 4 hrs to fix
      src/main/java/org/pdf/forms/writer/PdfCheckBoxWriter.java on lines 79..132
      src/main/java/org/pdf/forms/writer/PdfTextWriter.java on lines 50..104

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 289.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Identical blocks of code found in 5 locations. Consider refactoring.
      Open

          private void addBorder(
                  final IWidget widget,
                  final BaseField baseField) {
              final Optional<BorderProperties> borderProperties = widget.getWidgetModel().getProperties().getBorder();
              if (borderProperties.isEmpty()) {
      Severity: Major
      Found in src/main/java/org/pdf/forms/writer/PdfTextFieldWriter.java and 4 other locations - About 2 hrs to fix
      src/main/java/org/pdf/forms/writer/PdfButtonWriter.java on lines 75..105
      src/main/java/org/pdf/forms/writer/PdfCheckBoxWriter.java on lines 134..164
      src/main/java/org/pdf/forms/writer/PdfComboBoxWriter.java on lines 156..184
      src/main/java/org/pdf/forms/writer/PdfListBoxWriter.java on lines 171..200

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 173.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Identical blocks of code found in 8 locations. Consider refactoring.
      Open

          private Rectangle convertJavaCoordsToPdfCoords(
                  final java.awt.Rectangle bounds,
                  final Rectangle pageSize) {
              final float javaX1 = bounds.x - IMainFrame.INSET;
              final float javaY1 = bounds.y - IMainFrame.INSET;
      Severity: Major
      Found in src/main/java/org/pdf/forms/writer/PdfTextFieldWriter.java and 7 other locations - About 1 hr to fix
      src/main/java/org/pdf/forms/writer/PdfButtonWriter.java on lines 107..119
      src/main/java/org/pdf/forms/writer/PdfCheckBoxWriter.java on lines 166..179
      src/main/java/org/pdf/forms/writer/PdfComboBoxWriter.java on lines 186..198
      src/main/java/org/pdf/forms/writer/PdfImageWriter.java on lines 64..77
      src/main/java/org/pdf/forms/writer/PdfListBoxWriter.java on lines 202..214
      src/main/java/org/pdf/forms/writer/PdfTextWriter.java on lines 106..118
      src/main/java/org/pdf/forms/writer/Writer.java on lines 557..569

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 97.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Identical blocks of code found in 2 locations. Consider refactoring.
      Open

          private BaseFont getBaseFont(final Font font) throws IOException, DocumentException {
              final Optional<String> absoluteFontPath = fontHandler.getAbsoluteFontPath(font);
              if (absoluteFontPath.isPresent()) {
                  final String fontPath = absoluteFontPath.get();
                  try {
      Severity: Major
      Found in src/main/java/org/pdf/forms/writer/PdfTextFieldWriter.java and 1 other location - About 1 hr to fix
      src/main/java/org/pdf/forms/writer/PdfListBoxWriter.java on lines 216..232

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 94.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Extra separation in import group before 'org.pdf.forms.fonts.FontHandler'
      Open

      import org.pdf.forms.fonts.FontHandler;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.text.pdf.PdfContentByte' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.text.pdf.PdfContentByte;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Line is longer than 100 characters (found 108).
      Open

               * we need to make this erroneous call to awtToPdf to see if an exception is thrown, if it is, it is

      Checks for long lines.

      Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Line is longer than 100 characters (found 103).
      Open

              final int color = borders.getBorderColor().map(Integer::parseInt).orElse(Color.WHITE.getRGB());

      Checks for long lines.

      Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.text.pdf.PdfAction' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.text.pdf.PdfAction;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.text.pdf.PdfName' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.text.pdf.PdfName;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.text.Rectangle' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.text.Rectangle;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Line is longer than 100 characters (found 119).
      Open

              final Graphics2D graphics2D = cb.createGraphics(captionBounds.width, captionBounds.height, mapper, true, .95f);

      Checks for long lines.

      Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Line is longer than 100 characters (found 114).
      Open

              //Graphics2D graphics2D = cb.createGraphicsShapes(captionBounds.width, captionBounds.height, true, 0.95f);

      Checks for long lines.

      Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Line is longer than 100 characters (found 111).
      Open

              cb.concatCTM(1, 0, 0, 1, pdfCaptionBounds.getLeft(), pdfCaptionBounds.getTop() - captionBounds.height);

      Checks for long lines.

      Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Line is longer than 100 characters (found 101).
      Open

                      formField.setAdditionalActions(entry.getKey(), PdfAction.javaScript(script, writer));

      Checks for long lines.

      Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.text.DocumentException' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.text.DocumentException;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.text.pdf.BaseField' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.text.pdf.BaseField;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Line is longer than 100 characters (found 101).
      Open

                  final Caption caption = widget.getWidgetModel().getProperties().getLayout().getCaption();

      Checks for long lines.

      Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.awt.DefaultFontMapper' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.awt.DefaultFontMapper;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.text.BaseColor' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.text.BaseColor;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.text.pdf.PdfFormField' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.text.pdf.PdfFormField;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Using the '.*' form of import should be avoided - java.awt.*.
      Open

      import java.awt.*;

      Checks that there are no import statements that use the * notation.

      Rationale: Importing all classes from a package or staticmembers from a class leads to tight coupling between packagesor classes and might lead to problems when a new version of alibrary introduces name clashes.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Line is longer than 100 characters (found 112).
      Open

              final Optional<BorderProperties> borderProperties = widget.getWidgetModel().getProperties().getBorder();

      Checks for long lines.

      Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Extra separation in import group before 'com.itextpdf.awt.DefaultFontMapper'
      Open

      import com.itextpdf.awt.DefaultFontMapper;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.text.pdf.TextField' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.text.pdf.TextField;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.text.pdf.GrayColor' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.text.pdf.GrayColor;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.text.pdf.BaseFont' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.text.pdf.BaseFont;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.text.pdf.PdfBorderDictionary' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.text.pdf.PdfBorderDictionary;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Wrong lexicographical order for 'com.itextpdf.text.pdf.PdfWriter' import. Should be before 'org.slf4j.LoggerFactory'.
      Open

      import com.itextpdf.text.pdf.PdfWriter;

      Checks that the groups of import declarations appear in the order specifiedby the user. If there is an import but its group is not specified in theconfiguration such an import should be placed at the end of the import list.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      Line is longer than 100 characters (found 115).
      Open

               * probably because the font cannot be embedded due to licensing restrictions, so substitute with Helvetica

      Checks for long lines.

      Rationale: Long lines are hard to read in printouts or if developershave limited screen space for the source code, e.g. if the IDEdisplays additional information like project tree, class hierarchy,etc.

      This documentation is written and maintained by the Checkstyle community and is covered under the same license as the Checkstyle project.

      There are no issues that match your filters.

      Category
      Status