Commit 6c07af9e authored by Hallvard Trætteberg's avatar Hallvard Trætteberg
Browse files

Configured checkstyle and fixed issues

parent bb6c565d
{
"java.configuration.updateBuildConfiguration": "automatic"
"java.configuration.updateBuildConfiguration": "automatic",
"java.format.settings.url": "todolist/config/checkstyle/eclipse-java-google-style.xml"
}
This diff is collapsed.
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
<!--
Checkstyle configuration that checks the Google coding conventions from Google Java Style
that can be found at https://google.github.io/styleguide/javaguide.html
Checkstyle is very configurable. Be sure to read the documentation at
http://checkstyle.sf.net (or in your downloaded distribution).
To completely disable a check, just comment it out or delete it from the file.
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
-->
<module name = "Checker">
<property name="charset" value="UTF-8"/>
<property name="severity" value="warning"/>
<property name="fileExtensions" value="java, properties, xml"/>
<!-- Excludes all 'module-info.java' files -->
<!-- See https://checkstyle.org/config_filefilters.html -->
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$"/>
</module>
<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module>
<module name="TreeWalker">
<module name="OuterTypeFilename"/>
<module name="IllegalTokenText">
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
<property name="format"
value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
<property name="message"
value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
</module>
<module name="AvoidEscapedUnicodeCharacters">
<property name="allowEscapesForControlCharacters" value="true"/>
<property name="allowByTailComment" value="true"/>
<property name="allowNonPrintableEscapes" value="true"/>
</module>
<!--
<module name="LineLength">
<property name="max" value="100"/>
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
</module>
-->
<module name="AvoidStarImport"/>
<module name="OneTopLevelClass"/>
<module name="NoLineWrap"/>
<module name="EmptyBlock">
<property name="option" value="TEXT"/>
<property name="tokens"
value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
</module>
<module name="NeedBraces"/>
<module name="LeftCurly"/>
<module name="RightCurly">
<property name="id" value="RightCurlySame"/>
<property name="tokens"
value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
LITERAL_DO"/>
</module>
<module name="RightCurly">
<property name="id" value="RightCurlyAlone"/>
<property name="option" value="alone"/>
<property name="tokens"
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
INSTANCE_INIT"/>
</module>
<module name="WhitespaceAround">
<property name="allowEmptyConstructors" value="true"/>
<property name="allowEmptyLambdas" value="true"/>
<property name="allowEmptyMethods" value="true"/>
<property name="allowEmptyTypes" value="true"/>
<property name="allowEmptyLoops" value="true"/>
<message key="ws.notFollowed"
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
<message key="ws.notPreceded"
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
</module>
<module name="OneStatementPerLine"/>
<module name="MultipleVariableDeclarations"/>
<module name="ArrayTypeStyle"/>
<module name="MissingSwitchDefault"/>
<module name="FallThrough"/>
<module name="UpperEll"/>
<module name="ModifierOrder"/>
<module name="EmptyLineSeparator">
<property name="allowNoEmptyLineBetweenFields" value="true"/>
</module>
<module name="SeparatorWrap">
<property name="id" value="SeparatorWrapDot"/>
<property name="tokens" value="DOT"/>
<property name="option" value="nl"/>
</module>
<module name="SeparatorWrap">
<property name="id" value="SeparatorWrapComma"/>
<property name="tokens" value="COMMA"/>
<property name="option" value="EOL"/>
</module>
<module name="SeparatorWrap">
<!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 -->
<property name="id" value="SeparatorWrapEllipsis"/>
<property name="tokens" value="ELLIPSIS"/>
<property name="option" value="EOL"/>
</module>
<module name="SeparatorWrap">
<!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 -->
<property name="id" value="SeparatorWrapArrayDeclarator"/>
<property name="tokens" value="ARRAY_DECLARATOR"/>
<property name="option" value="EOL"/>
</module>
<module name="SeparatorWrap">
<property name="id" value="SeparatorWrapMethodRef"/>
<property name="tokens" value="METHOD_REF"/>
<property name="option" value="nl"/>
</module>
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
<message key="name.invalidPattern"
value="Package name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="TypeName">
<message key="name.invalidPattern"
value="Type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="MemberName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
<message key="name.invalidPattern"
value="Member name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="ParameterName">
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="LambdaParameterName">
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="CatchParameterName">
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="LocalVariableName">
<property name="tokens" value="VARIABLE_DEF"/>
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="ClassTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
<message key="name.invalidPattern"
value="Class type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="MethodTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
<message key="name.invalidPattern"
value="Method type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="InterfaceTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
<message key="name.invalidPattern"
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="NoFinalizer"/>
<module name="GenericWhitespace">
<message key="ws.followed"
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
<message key="ws.preceded"
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
<message key="ws.illegalFollow"
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
<message key="ws.notPreceded"
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
</module>
<module name="Indentation">
<property name="basicOffset" value="2"/>
<property name="braceAdjustment" value="0"/>
<property name="caseIndent" value="2"/>
<property name="throwsIndent" value="4"/>
<property name="lineWrappingIndentation" value="4"/>
<property name="arrayInitIndent" value="2"/>
</module>
<module name="AbbreviationAsWordInName">
<property name="ignoreFinal" value="false"/>
<property name="allowedAbbreviationLength" value="1"/>
</module>
<module name="OverloadMethodsDeclarationOrder"/>
<module name="VariableDeclarationUsageDistance"/>
<module name="CustomImportOrder">
<property name="sortImportsInGroupAlphabetically" value="true"/>
<property name="separateLineBetweenGroups" value="true"/>
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
</module>
<module name="MethodParamPad"/>
<module name="NoWhitespaceBefore">
<property name="tokens"
value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/>
<property name="allowLineBreaks" value="true"/>
</module>
<module name="ParenPad"/>
<module name="OperatorWrap">
<property name="option" value="NL"/>
<property name="tokens"
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
</module>
<module name="AnnotationLocation">
<property name="id" value="AnnotationLocationMostCases"/>
<property name="tokens"
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
</module>
<module name="AnnotationLocation">
<property name="id" value="AnnotationLocationVariables"/>
<property name="tokens" value="VARIABLE_DEF"/>
<property name="allowSamelineMultipleAnnotations" value="true"/>
</module>
<module name="NonEmptyAtclauseDescription"/>
<!-- Removed due to instantiation exception
<module name="InvalidJavadocPosition"/>
-->
<module name="JavadocTagContinuationIndentation"/>
<module name="SummaryJavadoc">
<property name="forbiddenSummaryFragments"
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
</module>
<module name="JavadocParagraph"/>
<module name="AtclauseOrder">
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
<property name="target"
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
</module>
<module name="JavadocMethod">
<property name="scope" value="public"/>
<property name="allowMissingParamTags" value="true"/>
<property name="allowMissingReturnTag" value="true"/>
<property name="allowedAnnotations" value="Override, Test"/>
<!-- Not supported anymore
<property name="allowMissingThrowsTags" value="true"/>
<property name="allowThrowsTagsForSubclasses" value="true"/>
-->
</module>
<!-- Removed due to instantiation exception
<module name="MissingJavadocMethod">
<property name="scope" value="public"/>
<property name="minLineCount" value="2"/>
<property name="allowedAnnotations" value="Override, Test"/>
</module>
-->
<module name="MethodName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
<message key="name.invalidPattern"
value="Method name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="SingleLineJavadoc">
<property name="ignoreInlineTags" value="false"/>
</module>
<module name="EmptyCatchBlock">
<property name="exceptionVariableName" value="expected"/>
</module>
<module name="CommentsIndentation"/>
</module>
</module>
......@@ -58,6 +58,23 @@
</dependencies>
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>3.1.1</version>
<dependencies>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
<version>8.36.1</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</pluginManagement>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
......@@ -102,7 +119,7 @@
<artifactId>maven-checkstyle-plugin</artifactId>
<version>3.1.1</version>
<configuration>
<configLocation>config/checkstyle/google_checks.xml</configLocation>
<configLocation>google_checks.xml</configLocation>
<encoding>UTF-8</encoding>
<consoleOutput>true</consoleOutput>
<failsOnError>true</failsOnError>
......
......@@ -2,31 +2,31 @@ package todolist.core;
public class TodoItem {
private String text;
private boolean checked;
private String text;
private boolean checked;
@Override
public String toString() {
return String.format("[TodoItem text=%s checked=%s]", getText(), isChecked());
}
@Override
public String toString() {
return String.format("[TodoItem text=%s checked=%s]", getText(), isChecked());
}
public String getText() {
return text;
}
public String getText() {
return text;
}
public void setText(String text) {
this.text = text;
}
public void setText(String text) {
this.text = text;
}
public boolean isChecked() {
return checked;
}
public boolean isChecked() {
return checked;
}
public void setChecked(boolean checked) {
this.checked = checked;
}
public void setChecked(boolean checked) {
this.checked = checked;
}
public void toggleChecked() {
setChecked(! checked);
}
public void toggleChecked() {
setChecked(!checked);
}
}
......@@ -7,80 +7,87 @@ import java.util.List;
public class TodoList implements Iterable<TodoItem> {
private List<TodoItem> items = new ArrayList<>();
public TodoItem createTodoItem() {
return new TodoListItem(this);
}
public void addTodoItem(TodoItem item) {
TodoListItem todoListItem = null;
if (item instanceof TodoListItem) {
todoListItem = (TodoListItem) item;
} else {
todoListItem = new TodoListItem(this);
todoListItem.setText(item.getText());
todoListItem.setChecked(item.isChecked());
}
items.add(todoListItem);
fireTodoListChanged();
}
public void removeTodoItem(TodoItem item) {
items.remove(item);
fireTodoListChanged();
}
@Override
public Iterator<TodoItem> iterator() {
return items.iterator();
private List<TodoItem> items = new ArrayList<>();
public TodoItem createTodoItem() {
return new TodoListItem(this);
}
/**
* Adds the provided TodoItem to this TodoList.
* If the TodoItem is not an instance of TodoListItem,
* its contents is copied in to a new TodoListItem and that is added instead.
*
* @param item the TodoItem to add
*/
public void addTodoItem(TodoItem item) {
TodoListItem todoListItem = null;
if (item instanceof TodoListItem) {
todoListItem = (TodoListItem) item;
} else {
todoListItem = new TodoListItem(this);
todoListItem.setText(item.getText());
todoListItem.setChecked(item.isChecked());
}
private Collection<TodoItem> getTodoItems(Boolean checked) {
Collection<TodoItem> result = new ArrayList<>(items.size());
for (TodoItem item : items) {
if (checked == null || item.isChecked() == checked) {
result.add(item);
}
}
return result;
// same as
// return items.stream()
// .filter(item -> checked == null || item.isChecked() == checked)
// .collect(Collectors.toList());
items.add(todoListItem);
fireTodoListChanged();
}
public void removeTodoItem(TodoItem item) {
items.remove(item);
fireTodoListChanged();
}
@Override
public Iterator<TodoItem> iterator() {
return items.iterator();
}
private Collection<TodoItem> getTodoItems(Boolean checked) {
Collection<TodoItem> result = new ArrayList<>(items.size());
for (TodoItem item : items) {
if (checked == null || item.isChecked() == checked) {
result.add(item);
}
}
return result;
// same as
// return items.stream()
// .filter(item -> checked == null || item.isChecked() == checked)
// .collect(Collectors.toList());
}
public Collection<TodoItem> getTodoItems() {
return getTodoItems(null);
}
public Collection<TodoItem> getTodoItems() {
return getTodoItems(null);
}
public Collection<TodoItem> getCheckedTodoItems() {
return getTodoItems(true);
}
public Collection<TodoItem> getCheckedTodoItems() {
return getTodoItems(true);
}
public Collection<TodoItem> getUncheckedTodoItems() {
return getTodoItems(false);
}
public Collection<TodoItem> getUncheckedTodoItems() {
return getTodoItems(false);
}
// støtte for lytting
// støtte for lytting
private Collection<TodoListListener> todoListListeners = new ArrayList<>();
private Collection<TodoListListener> todoListListeners = new ArrayList<>();
public void addTodoListListener(TodoListListener listener) {
todoListListeners.add(listener);
}
public void addTodoListListener(TodoListListener listener) {
todoListListeners.add(listener);
}
public void removeTodoListListener(TodoListListener listener) {
todoListListeners.remove(listener);
}
public void removeTodoListListener(TodoListListener listener) {
todoListListeners.remove(listener);
}
protected void fireTodoListChanged(TodoItem item) {
fireTodoListChanged();
}
protected void fireTodoListChanged(TodoItem item) {
fireTodoListChanged();
}
protected void fireTodoListChanged() {
for (TodoListListener listener : todoListListeners) {
listener.todoListChanged(this);
}
protected void fireTodoListChanged() {
for (TodoListListener listener : todoListListeners) {
listener.todoListChanged(this);
}
}
}
......@@ -2,27 +2,27 @@ package todolist.core;
public class TodoListItem extends TodoItem {
private final TodoList todoList;
private final TodoList todoList;
public TodoListItem(TodoList todoList) {
this.todoList = todoList;
}
public TodoListItem(TodoList todoList) {
this.todoList = todoList;
}
@Override
public void setText(String text) {
String oldText = getText();
super.setText(text);
if (oldText != text || oldText != null && ! (oldText.equals(text))) {
todoList.fireTodoListChanged(this);
}
@Override
public void setText(String text) {
String oldText = getText();
super.setText(text);
if (oldText != text || oldText != null && !(oldText.equals(text))) {
todoList.fireTodoListChanged(this);
}
}
@Override
public void setChecked(boolean checked) {
boolean oldChecked = isChecked();
super.setChecked(checked);
if (oldChecked != checked) {
todoList.fireTodoListChanged(this);
}
@Override
public void setChecked(boolean checked) {
boolean oldChecked = isChecked();
super.setChecked(checked);
if (oldChecked != checked) {
todoList.fireTodoListChanged(this);
}
}
\ No newline at end of file
}
}
package todolist.core;
public interface TodoListListener {
public void todoListChanged(TodoList list);
public void todoListChanged(TodoList list);
}
package todolist.json;
import java.io.IOException;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.TreeNode;
......@@ -11,31 +9,32 @@ import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.BooleanNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.fasterxml.jackson.databind.node.TextNode;
import java.io.IOException;
import todolist.core.TodoItem;
public class TodoItemDeserializer extends JsonDeserializer<TodoItem> {
@Override
public TodoItem deserialize(JsonParser parser, DeserializationContext ctxt) throws IOException, JsonProcessingException {