Sign upLogin

sjsucohort6/amigo-chatbot

View on GitHub
Star
user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java

Summary

Maintainability
A
1 hr
Test Coverage

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

    protected List<String> getListFromEntityId(String entityId) {
        List<String> entityIdsList = new ArrayList<>();

        if (entityId != null && !entityId.isEmpty()) {
            entityIdsList.add(entityId);
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java and 1 other location - About 40 mins to fix
command-processor-service/src/main/java/edu/sjsu/amigo/cp/rest/BaseResource.java on lines 95..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 52.

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

    protected List<T> getListFromEntity(T entity) {
        List<T> entitiesList = new ArrayList<>();

        if (entity != null) {
            entitiesList.add(entity);
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java and 1 other location - About 35 mins to fix
command-processor-service/src/main/java/edu/sjsu/amigo/cp/rest/BaseResource.java on lines 106..115

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

Using the '.*' form of import should be avoided - javax.ws.rs.*.
Open

import javax.ws.rs.*;
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

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

                             @Valid String entity) throws ResourceNotFoundException, InternalErrorException, IOException;
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

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 'java.util.List' import. Should be before 'javax.ws.rs.core.Response'.
Open

import java.util.List;
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

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.

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

    protected UserDAO userDAO;
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

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.

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

     * @param modelJson
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

Checks that the block tag is followed by description.

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 'javax.validation.Valid'
Open

import javax.validation.Valid;
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

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

     * Note: It is important to also define the @POST, @GET... etc annotations with the implementation methods in the
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

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 'java.io.IOException' import. Should be before 'javax.ws.rs.core.Response'.
Open

import java.io.IOException;
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

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 'java.util.ArrayList' import. Should be before 'javax.ws.rs.core.Response'.
Open

import java.util.ArrayList;
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

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.

'public' modifier out of order with the JLS suggestions.
Open

    abstract public T update(@Auth PrincipalUser user, @PathParam("id") String id,
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

Checks that the order of modifiers conforms to the suggestions inthe JavaLanguage specification, § 8.1.1, 8.3.1, 8.4.3 and9.4. The correct order is:

  1. public
  2. protected
  3. private
  4. abstract
  5. default
  6. static
  7. sealed
  8. non-sealed
  9. final
  10. transient
  11. volatile
  12. synchronized
  13. native
  14. strictfp

In additional, modifiers are checked to ensure all annotations aredeclared before all other modifiers.

Rationale: Code is easier to read if everybody follows a standard.

ATTENTION: We skiptype annotations from validation.

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
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

Checks that the block tag is followed by description.

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

'public' modifier out of order with the JLS suggestions.
Open

    abstract public Response create(@Valid String modelJson);
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

Checks that the order of modifiers conforms to the suggestions inthe JavaLanguage specification, § 8.1.1, 8.3.1, 8.4.3 and9.4. The correct order is:

  1. public
  2. protected
  3. private
  4. abstract
  5. default
  6. static
  7. sealed
  8. non-sealed
  9. final
  10. transient
  11. volatile
  12. synchronized
  13. native
  14. strictfp

In additional, modifiers are checked to ensure all annotations aredeclared before all other modifiers.

Rationale: Code is easier to read if everybody follows a standard.

ATTENTION: We skiptype annotations from validation.

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

'public' modifier out of order with the JLS suggestions.
Open

    abstract public  T retrieve(@PathParam("id") String id)
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

Checks that the order of modifiers conforms to the suggestions inthe JavaLanguage specification, § 8.1.1, 8.3.1, 8.4.3 and9.4. The correct order is:

  1. public
  2. protected
  3. private
  4. abstract
  5. default
  6. static
  7. sealed
  8. non-sealed
  9. final
  10. transient
  11. volatile
  12. synchronized
  13. native
  14. strictfp

In additional, modifiers are checked to ensure all annotations aredeclared before all other modifiers.

Rationale: Code is easier to read if everybody follows a standard.

ATTENTION: We skiptype annotations from validation.

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

    abstract public List<T> list(@Auth PrincipalUser user, @QueryParam("filter") String filter) throws InternalErrorException;
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

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.

'public' modifier out of order with the JLS suggestions.
Open

    abstract public Response delete(@Auth PrincipalUser user, @PathParam("id") String id)
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

Checks that the order of modifiers conforms to the suggestions inthe JavaLanguage specification, § 8.1.1, 8.3.1, 8.4.3 and9.4. The correct order is:

  1. public
  2. protected
  3. private
  4. abstract
  5. default
  6. static
  7. sealed
  8. non-sealed
  9. final
  10. transient
  11. volatile
  12. synchronized
  13. native
  14. strictfp

In additional, modifiers are checked to ensure all annotations aredeclared before all other modifiers.

Rationale: Code is easier to read if everybody follows a standard.

ATTENTION: We skiptype annotations from validation.

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

'public' modifier out of order with the JLS suggestions.
Open

    abstract public List<T> list(@Auth PrincipalUser user, @QueryParam("filter") String filter) throws InternalErrorException;
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

Checks that the order of modifiers conforms to the suggestions inthe JavaLanguage specification, § 8.1.1, 8.3.1, 8.4.3 and9.4. The correct order is:

  1. public
  2. protected
  3. private
  4. abstract
  5. default
  6. static
  7. sealed
  8. non-sealed
  9. final
  10. transient
  11. volatile
  12. synchronized
  13. native
  14. strictfp

In additional, modifiers are checked to ensure all annotations aredeclared before all other modifiers.

Rationale: Code is easier to read if everybody follows a standard.

ATTENTION: We skiptype annotations from validation.

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

First sentence of Javadoc is missing an ending period.
Open

    /**
Severity: Minor
Found in user-service/src/main/java/edu/sjsu/amigo/user/rest/BaseResource.java by checkstyle

Checks thatJavadoc summary sentence does not contain phrases that are not recommended to use.Summaries that contain only the {@inheritDoc} tag are skipped. Check alsoviolate Javadoc that does not contain first sentence.

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