prowide/prowide-core

View on GitHub
src/main/java/com/prowidesoftware/swift/model/field/Field.java

Summary

Maintainability
F
4 days
Test Coverage

File Field.java has 625 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/*
 * Copyright 2006-2023 Prowide
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
Severity: Major
Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 1 day to fix

    Field has 74 methods (exceeds 20 allowed). Consider refactoring.
    Open

    public abstract class Field implements PatternContainer, JsonSerializable {
        private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(Field.class.getName());
    
        /**
         * Zero based list of field components in String format.<br>
    Severity: Major
    Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 1 day to fix

      Method getLine has a Cognitive Complexity of 22 (exceeds 8 allowed). Consider refactoring.
      Open

          protected String getLine(final Field cp, final Integer start, final Integer end, final int offset) {
              final String hash = UUID.randomUUID().toString();
              for (int i = 1; i <= componentsSize(); i++) {
                  if (i < offset) {
                      // blank fields below the offset
      Severity: Minor
      Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 2 hrs to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Method _getLabel has a Cognitive Complexity of 21 (exceeds 8 allowed). Consider refactoring.
      Open

          private static String _getLabel(
                  final String fieldName, final String mt, final String sequence, final Locale locale, final String prop) {
              final String bundle = "pw_swift_labels";
              String key = null;
              String result = null;
      Severity: Minor
      Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 2 hrs to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Method _getLabel has 38 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private static String _getLabel(
                  final String fieldName, final String mt, final String sequence, final Locale locale, final String prop) {
              final String bundle = "pw_swift_labels";
              String key = null;
              String result = null;
      Severity: Minor
      Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 1 hr to fix

        Method getLine has 33 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            protected String getLine(final Field cp, final Integer start, final Integer end, final int offset) {
                final String hash = UUID.randomUUID().toString();
                for (int i = 1; i <= componentsSize(); i++) {
                    if (i < offset) {
                        // blank fields below the offset
        Severity: Minor
        Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 1 hr to fix

          Method fromJson has 28 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              public static Field fromJson(final String json) {
                  JsonObject jsonObject = JsonParser.parseString(json).getAsJsonObject();
                  JsonElement nameElement = jsonObject.get("name");
                  if (nameElement != null) {
                      String name = nameElement.getAsString();
          Severity: Minor
          Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 1 hr to fix

            Method getComponentAs has 26 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public Object getComponentAs(final int component, @SuppressWarnings("rawtypes") final Class c) {
                    try {
                        final String s = getComponent(component);
                        log.finest("converting string value: " + s);
            
            
            Severity: Minor
            Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 1 hr to fix

              Method appendInLines has a Cognitive Complexity of 12 (exceeds 8 allowed). Consider refactoring.
              Open

                  protected void appendInLines(final StringBuilder sb, final String... lines) {
                      Objects.requireNonNull(sb);
                      if (lines == null) {
                          log.finest("lines is null");
                      } else {
              Severity: Minor
              Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 55 mins to fix

              Cognitive Complexity

              Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

              A method's cognitive complexity is based on a few simple rules:

              • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
              • Code is considered more complex for each "break in the linear flow of the code"
              • Code is considered more complex when "flow breaking structures are nested"

              Further reading

              Avoid deeply nested control flow statements.
              Open

                                      if (end > lines.size()) {
                                          trimmedEnd = lines.size() - 1;
                                      }
              Severity: Major
              Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 45 mins to fix

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

                            final String fieldName, final String mt, final String sequence, final Locale locale, final String prop) {
                Severity: Minor
                Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 35 mins to fix

                  Method getComponentAs has a Cognitive Complexity of 10 (exceeds 8 allowed). Consider refactoring.
                  Open

                      public Object getComponentAs(final int component, @SuppressWarnings("rawtypes") final Class c) {
                          try {
                              final String s = getComponent(component);
                              log.finest("converting string value: " + s);
                  
                  
                  Severity: Minor
                  Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 35 mins to fix

                  Cognitive Complexity

                  Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                  A method's cognitive complexity is based on a few simple rules:

                  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                  • Code is considered more complex for each "break in the linear flow of the code"
                  • Code is considered more complex when "flow breaking structures are nested"

                  Further reading

                  Avoid too many return statements within this method.
                  Open

                          return null;
                  Severity: Major
                  Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                                return (BigDecimal) number;
                    Severity: Major
                    Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                                      return new BIC(s);
                      Severity: Major
                      Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 30 mins to fix

                        Avoid too many return statements within this method.
                        Open

                                        return SwiftFormatUtils.getNumber(s);
                        Severity: Major
                        Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 30 mins to fix

                          Avoid too many return statements within this method.
                          Open

                                          return SwiftFormatUtils.getBigDecimal(s);
                          Severity: Major
                          Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 30 mins to fix

                            Avoid too many return statements within this method.
                            Open

                                            return s;
                            Severity: Major
                            Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 30 mins to fix

                              Avoid too many return statements within this method.
                              Open

                                      return null;
                              Severity: Major
                              Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 30 mins to fix

                                Method fromJson has a Cognitive Complexity of 9 (exceeds 8 allowed). Consider refactoring.
                                Open

                                    public static Field fromJson(final String json) {
                                        JsonObject jsonObject = JsonParser.parseString(json).getAsJsonObject();
                                        JsonElement nameElement = jsonObject.get("name");
                                        if (nameElement != null) {
                                            String name = nameElement.getAsString();
                                Severity: Minor
                                Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java - About 25 mins to fix

                                Cognitive Complexity

                                Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

                                A method's cognitive complexity is based on a few simple rules:

                                • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
                                • Code is considered more complex for each "break in the linear flow of the code"
                                • Code is considered more complex when "flow breaking structures are nested"

                                Further reading

                                Refactor this method to reduce its Cognitive Complexity from 22 to the 15 allowed.
                                Open

                                    protected String getLine(final Field cp, final Integer start, final Integer end, final int offset) {

                                Cognitive Complexity is a measure of how hard the control flow of a method is to understand. Methods with high Cognitive Complexity will be difficult to maintain.

                                See

                                Refactor this method to reduce its Cognitive Complexity from 21 to the 15 allowed.
                                Open

                                    private static String _getLabel(

                                Cognitive Complexity is a measure of how hard the control flow of a method is to understand. Methods with high Cognitive Complexity will be difficult to maintain.

                                See

                                Define a constant instead of duplicating this literal "field" 7 times.
                                Open

                                                key = "field" + fieldName + "[" + mt + "][" + sequence + "]." + prop;

                                Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

                                On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

                                Noncompliant Code Example

                                With the default threshold of 3:

                                public void run() {
                                  prepare("action1");                              // Noncompliant - "action1" is duplicated 3 times
                                  execute("action1");
                                  release("action1");
                                }
                                
                                @SuppressWarning("all")                            // Compliant - annotations are excluded
                                private void method1() { /* ... */ }
                                @SuppressWarning("all")
                                private void method2() { /* ... */ }
                                
                                public String method3(String a) {
                                  System.out.println("'" + a + "'");               // Compliant - literal "'" has less than 5 characters and is excluded
                                  return "";                                       // Compliant - literal "" has less than 5 characters and is excluded
                                }
                                

                                Compliant Solution

                                private static final String ACTION_1 = "action1";  // Compliant
                                
                                public void run() {
                                  prepare(ACTION_1);                               // Compliant
                                  execute(ACTION_1);
                                  release(ACTION_1);
                                }
                                

                                Exceptions

                                To prevent generating some false-positives, literals having less than 5 characters are excluded.

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

                                            if (result == null) {
                                                /*
                                                 * number only
                                                 */
                                                key = "field" + getNumber(fieldName) + "." + prop;
                                Severity: Minor
                                Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java and 1 other location - About 35 mins to fix
                                src/main/java/com/prowidesoftware/swift/model/field/Field.java on lines 303..309

                                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 44.

                                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

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

                                                if (result == null) {
                                                    /*
                                                     * tag + generic letter option
                                                     */
                                                    key = "field" + getNumber(fieldName) + "a." + prop;
                                Severity: Minor
                                Found in src/main/java/com/prowidesoftware/swift/model/field/Field.java and 1 other location - About 35 mins to fix
                                src/main/java/com/prowidesoftware/swift/model/field/Field.java on lines 311..317

                                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 44.

                                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

                                Rename this constant name to match the regular expression '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'.
                                Open

                                    private static final String fieldNamePattern = "^\\d{2,3}[A-Z]?$";

                                Shared coding conventions allow teams to collaborate efficiently. This rule checks that all constant names match a provided regular expression.

                                Noncompliant Code Example

                                With the default regular expression ^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$:

                                public class MyClass {
                                  public static final int first = 1;
                                }
                                
                                public enum MyEnum {
                                  first;
                                }
                                

                                Compliant Solution

                                public class MyClass {
                                  public static final int FIRST = 1;
                                }
                                
                                public enum MyEnum {
                                  FIRST;
                                }
                                

                                There are no issues that match your filters.

                                Category
                                Status