com.github.javaparser.utils.Utils Maven / Gradle / Ivy
Show all versions of javaparser-core Show documentation
/*
* Copyright (C) 2007-2010 Júlio Vilmar Gesser.
* Copyright (C) 2011, 2013-2023 The JavaParser Team.
*
* This file is part of JavaParser.
*
* JavaParser can be used either under the terms of
* a) the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* b) the terms of the Apache License
*
* You should have received a copy of both licenses in LICENCE.LGPL and
* LICENCE.APACHE. Please refer to those files for details.
*
* JavaParser is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*/
package com.github.javaparser.utils;
import com.github.javaparser.ast.Node;
import com.github.javaparser.ast.expr.UnaryExpr;
import java.io.IOException;
import java.io.Reader;
import java.util.*;
import java.util.function.Function;
import static java.util.Arrays.asList;
/**
* Any kind of utility.
*
* @author Federico Tomassetti
*/
public class Utils {
/**
* // TODO: Replace this within the internal codebase.
* @deprecated New code should use {@link LineSeparator#SYSTEM} if referring to the current host system's line separator,
* else {@link LineSeparator#CR} or {@link LineSeparator#LF} or {@link LineSeparator#CRLF} if referring to a specific style of line separator.
*/
@Deprecated
public static final String EOL = LineSeparator.SYSTEM.asRawString();
/**
* @deprecated Renamed from {@link #EOL} to make it explicit that we're using the system's line separator.
* New code should use {@link LineSeparator#SYSTEM} if referring to the current host system's line separator,
* else {@link LineSeparator#CR} or {@link LineSeparator#LF} or {@link LineSeparator#CRLF} if referring to a specific style of line separator.
*/
@Deprecated
public static final String SYSTEM_EOL = LineSeparator.SYSTEM.asRawString();
public static boolean isNullOrEmpty(Collection collection) {
return collection == null || collection.isEmpty();
}
public static T assertNotNull(T o) {
if (o == null) {
throw new AssertionError("A reference was unexpectedly null.");
}
return o;
}
public static String assertNonEmpty(String string) {
if (string == null || string.isEmpty()) {
throw new AssertionError("A string was unexpectedly empty.");
}
return string;
}
public static T assertNonNegative(T number) {
if (number.longValue() < 0) {
throw new AssertionError("A number was unexpectedly negative.");
}
return number;
}
public static T assertPositive(T number) {
if (number.longValue() <= 0) {
throw new AssertionError("A number was unexpectedly non-positive.");
}
return number;
}
/**
* @return string with ASCII characters 10 and 13 replaced by the text "\n" and "\r".
*/
public static String escapeEndOfLines(String string) {
StringBuilder escapedString = new StringBuilder();
for (char c : string.toCharArray()) {
switch(c) {
case '\n':
escapedString.append("\\n");
break;
case '\r':
escapedString.append("\\r");
break;
default:
escapedString.append(c);
}
}
return escapedString.toString();
}
public static String readerToString(Reader reader) throws IOException {
final StringBuilder result = new StringBuilder();
final char[] buffer = new char[8 * 1024];
int numChars;
while ((numChars = reader.read(buffer, 0, buffer.length)) > 0) {
result.append(buffer, 0, numChars);
}
return result.toString();
}
/**
* @deprecated use screamingToCamelCase
*/
@Deprecated
public static String toCamelCase(String original) {
return screamingToCamelCase(original);
}
/**
* Transform a string to the camel case conversion.
*
* For example "ABC_DEF" becomes "abcDef"
*/
public static String screamingToCamelCase(String original) {
StringBuilder sb = new StringBuilder();
String[] parts = original.toLowerCase().split("_");
for (int i = 0; i < parts.length; i++) {
sb.append(i == 0 ? parts[i] : capitalize(parts[i]));
}
return sb.toString();
}
/**
* @param input "aCamelCaseString"
* @return "A_CAMEL_CASE_STRING"
*/
public static String camelCaseToScreaming(String input) {
if (input.isEmpty()) {
return "";
}
StringBuilder scream = new StringBuilder(input.substring(0, 1).toUpperCase());
for (char c : input.substring(1).toCharArray()) {
if (Character.isUpperCase(c)) {
scream.append("_");
}
scream.append(Character.toUpperCase(c));
}
return scream.toString();
}
/**
* Return the next word of the string, in other words it stops when a space is encountered.
*/
public static String nextWord(String string) {
int index = 0;
while (index < string.length() && !Character.isWhitespace(string.charAt(index))) {
index++;
}
return string.substring(0, index);
}
/**
* Make an indent by appending indentLevel tab characters to the builder.
*/
public static StringBuilder indent(StringBuilder builder, int indentLevel) {
for (int i = 0; i < indentLevel; i++) {
builder.append("\t");
}
return builder;
}
/**
* Capitalizes the first character in the string.
*/
public static String capitalize(String s) {
return stringTransformer(s, "capitalize", String::toUpperCase);
}
/**
* Lower-cases the first character in the string.
*/
public static String decapitalize(String s) {
return stringTransformer(s, "decapitalize", String::toLowerCase);
}
private static String stringTransformer(String s, String operationDescription, Function transformation) {
if (s.isEmpty()) {
throw new IllegalArgumentException(String.format("You cannot %s an empty string", operationDescription));
}
return transformation.apply(s.substring(0, 1)) + s.substring(1);
}
/**
* @return true if the value is null, an empty Optional, or an empty String.
*/
public static boolean valueIsNullOrEmpty(Object value) {
if (value == null) {
return true;
}
if (value instanceof Optional) {
if (((Optional) value).isPresent()) {
value = ((Optional) value).get();
} else {
return true;
}
}
if (value instanceof Collection) {
if (((Collection) value).isEmpty()) {
return true;
}
}
return false;
}
public static boolean valueIsNullOrEmptyStringOrOptional(Object value) {
if (value == null) {
return true;
}
if (value instanceof Optional) {
if (((Optional) value).isPresent()) {
value = ((Optional) value).get();
} else {
return true;
}
}
return false;
}
/**
* Like {@link List#set(int, Object)} at {@link List#indexOf(Object)}, but using ==, not equals.
*/
public static void replaceElementByObjectIdentity(List list, E oldObject, E newObject) {
int index = indexOfElementByObjectIdentity(list, oldObject);
if (index == -1) {
return;
}
list.set(index, newObject);
}
/**
* Like {@link List#remove(Object)}, but using ==, not equals.
*/
public static void removeElementByObjectIdentity(List list, E o) {
int index = indexOfElementByObjectIdentity(list, o);
if (index == -1) {
return;
}
list.remove(index);
}
/**
* Like {@link List#indexOf(Object)}, but using ==, not equals.
*/
public static int indexOfElementByObjectIdentity(List list, E o) {
for (int i = 0; i < list.size(); i++) {
Object listO = list.get(i);
if (o == listO) {
return i;
}
}
return -1;
}
/**
* @return a set of the items.
*/
@SafeVarargs
public static Set set(T... items) {
return new HashSet<>(asList(items));
}
/**
* @return content, with all kinds of EOL characters replaced by desiredEndOfLineCharacter
*/
public static String normalizeEolInTextBlock(String content, String desiredEndOfLineCharacter) {
return content.replaceAll("\\R", desiredEndOfLineCharacter);
}
/**
* @return content, with all kinds of EOL characters replaced by desiredEndOfLineCharacter
*/
public static String normalizeEolInTextBlock(String content, LineSeparator desiredEndOfLineCharacter) {
return normalizeEolInTextBlock(content, desiredEndOfLineCharacter.asRawString());
}
/**
* @return the filename with the last "." and everything following it removed.
*/
public static String removeFileExtension(String filename) {
int extensionIndex = filename.lastIndexOf(".");
if (extensionIndex == -1)
return filename;
return filename.substring(0, extensionIndex);
}
/**
* Like {@link String#trim()}, but only the trailing spaces.
*/
public static String trimTrailingSpaces(String line) {
while (line.length() > 0 && line.charAt(line.length() - 1) <= 0x20) {
line = line.substring(0, line.length() - 1);
}
return line;
}
/**
* Checks, if the parent is a unary expression with a minus operator. Used to check for negative literals.
*/
public static boolean hasUnaryMinusAsParent(Node n) {
return n.getParentNode().filter(parent -> parent instanceof UnaryExpr).map(parent -> (UnaryExpr) parent).map(unaryExpr -> unaryExpr.getOperator() == UnaryExpr.Operator.MINUS).orElse(false);
}
}