brandboat commented on code in PR #21601: URL: https://github.com/apache/kafka/pull/21601#discussion_r2869387390
########## clients/src/main/java/org/apache/kafka/common/utils/internals/BytesUtils.java: ########## @@ -0,0 +1,94 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.kafka.common.utils.internals; + +import org.apache.kafka.common.utils.Bytes; + +import java.io.Serializable; +import java.util.Arrays; +import java.util.Comparator; + +/** + * Internal utility class for Bytes-related operations. + * This class is for internal Kafka use only and is not part of the public API. + */ +public final class BytesUtils { + + private BytesUtils() { + // Utility class, prevent instantiation + } + + /** + * Increment the underlying byte array by adding 1. Throws an IndexOutOfBoundsException if incrementing would cause + * the underlying input byte array to overflow. + * + * @param input - The byte array to increment + * @return A new copy of the incremented byte array. + */ + public static Bytes increment(Bytes input) throws IndexOutOfBoundsException { + byte[] inputArr = input.get(); + byte[] ret = new byte[inputArr.length]; + int carry = 1; + for (int i = inputArr.length - 1; i >= 0; i--) { + if (inputArr[i] == (byte) 0xFF && carry == 1) { + ret[i] = (byte) 0x00; + } else { + ret[i] = (byte) (inputArr[i] + carry); + carry = 0; + } + } + if (carry == 0) { + return Bytes.wrap(ret); + } else { + throw new IndexOutOfBoundsException(); + } + } + + /** + * A byte array comparator based on lexicograpic ordering. Review Comment: ditto, `lexicographic` ########## clients/src/main/java/org/apache/kafka/common/utils/Bytes.java: ########## @@ -146,57 +163,36 @@ private static String toString(final byte[] b, int off, int len) { * * @param input - The byte array to increment * @return A new copy of the incremented byte array. + * @deprecated This method is not part of the public API and will be removed in version 5.0. + * Internal Kafka code should use {@link org.apache.kafka.common.utils.internals.BytesUtils#increment(Bytes)} instead. */ + @Deprecated(since = "4.3", forRemoval = true) public static Bytes increment(Bytes input) throws IndexOutOfBoundsException { - byte[] inputArr = input.get(); - byte[] ret = new byte[inputArr.length]; - int carry = 1; - for (int i = inputArr.length - 1; i >= 0; i--) { - if (inputArr[i] == (byte) 0xFF && carry == 1) { - ret[i] = (byte) 0x00; - } else { - ret[i] = (byte) (inputArr[i] + carry); - carry = 0; - } - } - if (carry == 0) { - return wrap(ret); - } else { - throw new IndexOutOfBoundsException(); - } + return BytesUtils.increment(input); } /** * A byte array comparator based on lexicograpic ordering. Review Comment: not directly related to this PR, would you mind do a minor typo fix here? ```suggestion * A byte array comparator based on lexicographic ordering. ``` ########## clients/src/main/java/org/apache/kafka/common/utils/internals/BytesUtils.java: ########## @@ -0,0 +1,94 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.kafka.common.utils.internals; + +import org.apache.kafka.common.utils.Bytes; + +import java.io.Serializable; +import java.util.Arrays; +import java.util.Comparator; + +/** + * Internal utility class for Bytes-related operations. + * This class is for internal Kafka use only and is not part of the public API. + */ +public final class BytesUtils { + + private BytesUtils() { + // Utility class, prevent instantiation + } + + /** + * Increment the underlying byte array by adding 1. Throws an IndexOutOfBoundsException if incrementing would cause Review Comment: Could you please use javadoc `@throws`? This could make it a bit clear imo. ``` @throws IndexOutOfBoundsException if... ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
