Skip to content

Makes ByteCount Comparable to make it easier to write validations. #6156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dlvenable merged 1 commit into from
Oct 10, 2025
Merged

Makes ByteCount Comparable to make it easier to write validations. #6156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion data-prepper-api/src/main/java/org/opensearch/dataprepper/model/types/ByteCount.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
*
* @since 2.1
*/
public class ByteCount {
public class ByteCount implements Comparable<ByteCount> {
private static final Pattern BYTE_PATTERN = Pattern.compile("^(?<value>\\d+\\.?\\d*)(?<unit>[a-z]+)?\\z");
private static final ByteCount ZERO_BYTES = new ByteCount(0);
private final long bytes;
Expand Down Expand Up @@ -167,4 +167,9 @@ public boolean equals(final Object otherObject) {
public String toString() {
return bytes + Unit.BYTE.unitString;
}

@Override
public int compareTo(final ByteCount otherByteCount) {
return Long.compare(this.bytes, otherByteCount.bytes);
}
}
24 changes: 20 additions & 4 deletions data-prepper-api/src/test/java/org/opensearch/dataprepper/model/types/ByteCountTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@
import org.junit.jupiter.params.provider.CsvSource;
import org.junit.jupiter.params.provider.ValueSource;

import java.util.Random;

import static org.hamcrest.CoreMatchers.not;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.containsString;
Expand All @@ -21,8 +19,6 @@
import static org.junit.jupiter.api.Assertions.assertThrows;

class ByteCountTest {
private final Random random = new Random();

@ParameterizedTest
@ValueSource(strings = {
".1b",
Expand Down Expand Up @@ -262,4 +258,24 @@ void toString_returns_string_that_parses_to_the_same_value(final long bytes) {
assertThat(parsedByteCount, equalTo(objectUnderTest));
assertThat(parsedByteCount.hashCode(), equalTo(objectUnderTest.hashCode()));
}

@ParameterizedTest
@CsvSource({
"0b, 0b, 0",
"1b, 1b, 0",
"0b, 1b, -1",
"1b, 0b, 1",
"1kb, 1024b, 0",
"512b, 1kb, -1",
"2kb, 1kb, 1",
"1mb, 1kb, 1",
"1kb, 1mb, -1",
"1gb, 1mb, 1",
"500mb, 1gb, -1"
})
void compareTo_returns_expected_comparison_result(final String firstByteString, final String secondByteString, final int expectedResult) {
final ByteCount first = ByteCount.parse(firstByteString);
final ByteCount second = ByteCount.parse(secondByteString);
assertThat(first.compareTo(second), equalTo(expectedResult));
}
}
Loading