theshoeshiner commented on code in PR #450: URL: https://github.com/apache/commons-text/pull/450#discussion_r1370038780
########## src/main/java/org/apache/commons/text/cases/CharacterDelimitedCase.java: ########## @@ -0,0 +1,144 @@ +/* + * 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.commons.text.cases; + +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +import org.apache.commons.lang3.CharUtils; + +/** + * DelimitedCase is a case in which the true alphabetic case of the characters is ignored by default + * and tokens themselves are determined by the presence of a delimiter between each token. + */ +public class CharacterDelimitedCase implements Case { + + /** Delimiters to be used when parsing. */ + private Set<Integer> parseDelimiters; + + /** Delimiter to be used when formatting. */ + private String formatDelimiter; + + /** + * Constructs a new Delimited Case. + * @param delimiter the character to use as both the parse and format delimiter + */ + protected CharacterDelimitedCase(char delimiter) { + this(new char[] { delimiter }, CharUtils.toString(delimiter)); + } + + /** + * Constructs a new delimited case. + * @param parseDelimiters the array of delimiters to use when parsing + * @param formatDelimiter the delimiter to use when formatting + */ + protected CharacterDelimitedCase(char[] parseDelimiters, String formatDelimiter) { + super(); + if (parseDelimiters == null || parseDelimiters.length == 0) { + throw new IllegalArgumentException("Parse Delimiters cannot be null or empty"); + } + if (formatDelimiter == null || formatDelimiter.length() == 0) { + throw new IllegalArgumentException("Format Delimiters cannot be null or empty"); + } + this.parseDelimiters = generateDelimiterSet(parseDelimiters); + this.formatDelimiter = formatDelimiter; + } + + /** + * Formats tokens into Delimited Case. + * <p> + * Tokens are iterated on and appended to an output stream, with an instance of a + * delimiter character between them. This method validates that the delimiter character is not + * part of the token. If it is found within the token an exception is thrown.<br> + * No other restrictions are placed on the contents of the tokens. + * Note: This Case does support empty tokens.<br> + * </p> + * @param tokens the tokens to be formatted into a delimited string + * @return the delimited string + * @throws IllegalArgumentException if any tokens contain the delimiter character + */ + @Override + public String format(Iterable<String> tokens) { + StringBuilder formattedString = new StringBuilder(); + int i = 0; + for (String token : tokens) { + int delimiterFoundIndex = token.indexOf(formatDelimiter); + if (delimiterFoundIndex > -1) { + throw new IllegalArgumentException("Token " + i + " contains delimiter character '" + formatDelimiter + "' at index " + delimiterFoundIndex); + } + if (i > 0) { Review Comment: Unless there are serious performance concerns, I would prefer to leave it as an integer, the reason being that the exception message can be much more helpful by specifying exactly which token the error is in. The alternative is to reference the full token string, and I'm reluctant to include what could possibly be user and/or sensitive input in the exception message. -- 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]
