Skip to content
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

Add missing BitSet JavaDocs #2888

Merged
merged 1 commit into from
Oct 10, 2024
Merged

Add missing BitSet JavaDocs #2888

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
100 changes: 100 additions & 0 deletions vavr/src/main/java/io/vavr/collection/BitSet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,14 +139,30 @@ static Collector<Integer, ArrayList<Integer>, BitSet<Integer>> collector() {
return Builder.DEFAULT.collector();
}

/**
* Returns a BitSet containing no elements.
*
* @return an empty BitSet
*/
static BitSet<Integer> empty() {
return Builder.DEFAULT.empty();
}

/**
* Returns a BitSet containing a single value.
*
* @param value A single value
* @return A BitSet containing the given value
*/
static BitSet<Integer> of(Integer value) {
return Builder.DEFAULT.of(value);
}

/**
* Creates a BitSet of int numbers starting from {@code from}, extending to {@code toExclusive - 1}.
* @param values int values
* @return A new BitSet of int values
*/
static BitSet<Integer> of(Integer... values) {
return Builder.DEFAULT.of(values);
}
Expand Down Expand Up @@ -176,10 +192,20 @@ static BitSet<Integer> fill(int n, Supplier<Integer> s) {
return Builder.DEFAULT.fill(n, s);
}

/**
* Creates a BitSet of int numbers starting from {@code from}, extending to {@code toExclusive - 1}.
* @param values int values
* @return A new BitSet of int values
*/
static BitSet<Integer> ofAll(Iterable<Integer> values) {
return Builder.DEFAULT.ofAll(values);
}

/**
* Creates a BitSet of int numbers starting from {@code from}, extending to {@code toExclusive - 1}.
* @param javaStream A java.util.stream.Stream of int values
* @return A new BitSet of int values
*/
static BitSet<Integer> ofAll(java.util.stream.Stream<Integer> javaStream) {
return Builder.DEFAULT.ofAll(javaStream);
}
Expand Down Expand Up @@ -267,10 +293,24 @@ static BitSet<Integer> range(int from, int toExclusive) {
return BitSet.ofAll(Iterator.range(from, toExclusive));
}

/**
* Creates a BitSet of char numbers starting from {@code from}, extending to {@code toExclusive - 1}.
*
* @param from the first number
* @param toExclusive the last number + 1
* @return a range of char values as specified or the empty range if {@code from >= toExclusive}
*/
static BitSet<Character> range(char from, char toExclusive) {
return BitSet.withCharacters().ofAll(Iterator.range(from, toExclusive));
}

/**
* Creates a BitSet of long numbers starting from {@code from}, extending to {@code toExclusive - 1}.
*
* @param from the first number
* @param toExclusive the last number + 1
* @return a range of long values as specified or the empty range if {@code from >= toExclusive}
*/
static BitSet<Long> range(long from, long toExclusive) {
return BitSet.withLongs().ofAll(Iterator.range(from, toExclusive));
}
Expand All @@ -291,10 +331,32 @@ static BitSet<Integer> rangeBy(int from, int toExclusive, int step) {
return BitSet.ofAll(Iterator.rangeBy(from, toExclusive, step));
}

/** Creates a BitSet of char numbers starting from {@code from}, extending to {@code toExclusive - 1},
* with {@code step}.
*
* @param from the first number
* @param toExclusive the last number + 1
* @param step the step
* @return a range of char values as specified or the empty range if<br>
* {@code from >= toInclusive} and {@code step > 0} or<br>
* {@code from <= toInclusive} and {@code step < 0}
* @throws IllegalArgumentException if {@code step} is zero
*/
static BitSet<Character> rangeBy(char from, char toExclusive, int step) {
return BitSet.withCharacters().ofAll(Iterator.rangeBy(from, toExclusive, step));
}

/** Creates a BitSet of long numbers starting from {@code from}, extending to {@code toExclusive - 1},
* with {@code step}.
*
* @param from the first number
* @param toExclusive the last number + 1
* @param step the step
* @return a range of long values as specified or the empty range if<br>
* {@code from >= toInclusive} and {@code step > 0} or<br>
* {@code from <= toInclusive} and {@code step < 0}
* @throws IllegalArgumentException if {@code step} is zero
*/
static BitSet<Long> rangeBy(long from, long toExclusive, long step) {
return BitSet.withLongs().ofAll(Iterator.rangeBy(from, toExclusive, step));
}
Expand All @@ -310,10 +372,24 @@ static BitSet<Integer> rangeClosed(int from, int toInclusive) {
return BitSet.ofAll(Iterator.rangeClosed(from, toInclusive));
}

/**
* Creates a BitSet of char numbers starting from {@code from}, extending to {@code toInclusive}.
*
* @param from the first number
* @param toInclusive the last number
* @return a range of char values as specified or the empty range if {@code from > toInclusive}
*/
static BitSet<Character> rangeClosed(char from, char toInclusive) {
return BitSet.withCharacters().ofAll(Iterator.rangeClosed(from, toInclusive));
}

/**
* Creates a BitSet of long numbers starting from {@code from}, extending to {@code toInclusive}.
*
* @param from the first number
* @param toInclusive the last number
* @return a range of long values as specified or the empty range if {@code from > toInclusive}
*/
static BitSet<Long> rangeClosed(long from, long toInclusive) {
return BitSet.withLongs().ofAll(Iterator.rangeClosed(from, toInclusive));
}
Expand All @@ -334,10 +410,34 @@ static BitSet<Integer> rangeClosedBy(int from, int toInclusive, int step) {
return BitSet.ofAll(Iterator.rangeClosedBy(from, toInclusive, step));
}

/**
* Creates a BitSet of char numbers starting from {@code from}, extending to {@code toInclusive},
* with {@code step}.
*
* @param from the first number
* @param toInclusive the last number
* @param step the step
* @return a range of char values as specified or the empty range if<br>
* {@code from > toInclusive} and {@code step > 0} or<br>
* {@code from < toInclusive} and {@code step < 0}
* @throws IllegalArgumentException if {@code step} is zero
*/
static BitSet<Character> rangeClosedBy(char from, char toInclusive, int step) {
return BitSet.withCharacters().ofAll(Iterator.rangeClosedBy(from, toInclusive, step));
}

/**
* Creates a BitSet of long numbers starting from {@code from}, extending to {@code toInclusive},
* with {@code step}.
*
* @param from the first number
* @param toInclusive the last number
* @param step the step
* @return a range of long values as specified or the empty range if<br>
* {@code from > toInclusive} and {@code step > 0} or<br>
* {@code from < toInclusive} and {@code step < 0}
* @throws IllegalArgumentException if {@code step} is zero
*/
static BitSet<Long> rangeClosedBy(long from, long toInclusive, long step) {
return BitSet.withLongs().ofAll(Iterator.rangeClosedBy(from, toInclusive, step));
}
Expand Down