sjsucohort6/amigo-chatbot

View on GitHub
chatbot-service/src/main/java/edu/sjsu/amigo/chatbot/nlp/WitDotAIClient.java

Summary

Maintainability
A
1 hr
Test Coverage

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

    @Override
    public List<String> getIntent(String message) {
        try(HttpClient httpClient = new HttpClient()) {
            String url = WIT_AI_URL_PREFIX + WIT_AI_MESSAGE_URI;
            queryStringMap.put("q", message);

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

    import java.util.*;

    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.

    Abbreviation in name 'WitDotAIClient' must contain no more than '2' consecutive capital letters.
    Open

    public class WitDotAIClient implements AIClient {

    Validates abbreviations (consecutive capital letters) length in identifier name,it also allows to enforce camel case naming. Please read more atGoogle Style Guideto get to know how to avoid long abbreviations in names.

    allowedAbbreviationLength specifies how many consecutive capital letters areallowed in the identifier.A value of 3 indicates that up to 4 consecutive capital letters are allowed,one after the other, before a violation is printed. The identifier 'MyTEST' would beallowed, but 'MyTESTS' would not be.A value of 0 indicates that only 1 consecutive capital letter is allowed. Thisis what should be used to enforce strict camel casing. The identifier 'MyTest' wouldbe allowed, but 'MyTEst' would not be.

    ignoreFinal, ignoreStatic, and ignoreStaticFinalcontrol whether variables with the respective modifiers are to be ignored.Note that a variable that is both static and final will always be considered underignoreStaticFinal only, regardless of the values of ignoreFinaland ignoreStatic. So for example if ignoreStatic is true butignoreStaticFinal is false, then static final variables will not be ignored.

    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 104).
    Open

                Response<String> resp = httpClient.get(url, null, queryStringMap, headersMap, String.class);

    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 'java.io.IOException'
    Open

    import java.io.IOException;

    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.

    Empty line should be followed by <p> tag on the next line.</p>
    Open

         *

    Checks the Javadoc paragraph.

    Checks that:

    • There is one blank line between each of two paragraphs.
    • Each paragraph but the first has <p> immediately before the first word, withno space after.

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

    At-clause should have a non-empty description.
    Open

         * @return

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

        public static final String WIT_AI_SERVER_ACCESS_TOKEN = System.getenv("WIT_AI_SERVER_ACCESS_TOKEN");

    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 'edu.sjsu.amigo.mp.kafka.InvalidMessageException' import. Should be before 'edu.sjsu.amigo.mp.model.IntentElem'.
    Open

    import edu.sjsu.amigo.mp.kafka.InvalidMessageException;

    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 'edu.sjsu.amigo.json.util.JsonUtils' import. Should be before 'edu.sjsu.amigo.mp.model.IntentElem'.
    Open

    import edu.sjsu.amigo.json.util.JsonUtils;

    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.

    '}' at column 30 should be alone on a line.
    Open

        public WitDotAIClient() {}

    Checks the placement of right curly braces ('}') for code blocks.This check supports if-else, try-catch-finally blocks, while-loops, for-loops,method definitions, class definitions, constructor definitions,instance, static initialization blocks, annotation definitions and enum definitions.For right curly brace of expression blocks of arrays, lambdas and class instancesplease follow issue#5945.For right curly brace of enum constant please follow issue#7519.

    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