Commit 55674e87 authored by Riegel's avatar Riegel
Browse files

Docs: Add JavaDoc

parent c07d326d
...@@ -22,13 +22,15 @@ import java.util.Collections; ...@@ -22,13 +22,15 @@ import java.util.Collections;
import java.util.Set; import java.util.Set;
/** /**
* This is an empty implementation for a check. Can be used as a normal visitor *
* for the city doctor data model * This class serves as a Parent for non-validating checks that want to use the CheckEngine's Visitor-pattern for the
* implementation of utility functions like e.g. collecting the sub-CityObjects in a Feature.
*
* *
* @author Matthias Betz * @author Matthias Betz
* *
*/ */
public class AbstractCheck extends Check { public abstract class AbstractCheck extends Check {
@Override @Override
public Set<Requirement> appliesToRequirements() { public Set<Requirement> appliesToRequirements() {
......
...@@ -6,6 +6,9 @@ import de.hft.stuttgart.citydoctor2.datastructure.CityObject; ...@@ -6,6 +6,9 @@ import de.hft.stuttgart.citydoctor2.datastructure.CityObject;
import java.util.HashSet; import java.util.HashSet;
import java.util.Set; import java.util.Set;
/**
* This AbstractCheck collects all CityObjects in the substructure of a Feature.
*/
public class CityObjectCollector extends AbstractCheck { public class CityObjectCollector extends AbstractCheck {
private final Set<CityObject> objects = new HashSet<>(); private final Set<CityObject> objects = new HashSet<>();
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment