[Minor] Added JavaDoc to Parameter.compareTo()

This commit is contained in:
Robert von Burg 2019-01-29 14:41:51 +01:00
parent a85fa26b5e
commit 6d9a9464d8
2 changed files with 16 additions and 0 deletions

View File

@ -198,6 +198,14 @@ public abstract class AbstractParameter<T> extends AbstractStrolchElement implem
return builder.toString();
}
/**
* Compares the value of the given parameter to this parameter
*
* @param otherParam
* the parameter for which the value is to be compared to
*
* @return the {@link Comparable#compareTo(Object)} result
*/
@Override
public abstract int compareTo(Parameter<?> otherParam);
}

View File

@ -185,6 +185,14 @@ public interface Parameter<T> extends StrolchElement, Comparable<Parameter<?>> {
@Override
boolean equals(Object obj);
/**
* Compares the value of the given parameter to this parameter
*
* @param o
* the parameter for which the value is to be compared to
*
* @return the {@link Comparable#compareTo(Object)} result
*/
@Override
int compareTo(Parameter<?> o);