Skip to content
Snippets Groups Projects
Verified Commit 37a6b5e1 authored by David Procházka's avatar David Procházka
Browse files

ADD: javadoc for merge type

parent 2bd71c1f
No related branches found
No related tags found
No related merge requests found
...@@ -5,12 +5,18 @@ import messif.objects.LocalAbstractObject; ...@@ -5,12 +5,18 @@ import messif.objects.LocalAbstractObject;
import java.util.List; import java.util.List;
public enum MergeType { public enum MergeType {
/**
* Every object in descendants leaf node's bucket is retrieved and returned.
*/
OBJECT_BASED { OBJECT_BASED {
@Override @Override
public List<LocalAbstractObject> getObjects(Node node) { public List<LocalAbstractObject> getObjects(Node node) {
return node.getObjects(); return node.getObjects();
} }
}, },
/**
* Returns the hull objects of {@code node}'s hull.
*/
HULL_BASED { HULL_BASED {
@Override @Override
public List<LocalAbstractObject> getObjects(Node node) { public List<LocalAbstractObject> getObjects(Node node) {
...@@ -18,5 +24,12 @@ public enum MergeType { ...@@ -18,5 +24,12 @@ public enum MergeType {
} }
}; };
/**
* Return a list of objects from the {@code node} specified by the merge type.
* Result is used for building a new hull.
*
* @param node a node
* @return a list of objects from the {@code node} specified by the merge type
*/
abstract public List<LocalAbstractObject> getObjects(Node node); abstract public List<LocalAbstractObject> getObjects(Node node);
} }
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment