org.neo4j.gqlstatus.GqlStatusInfoCodes Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [https://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see params) {
return messageFormat.format(orderedParams(params));
}
@Override
public String getSubCondition() {
return subCondition;
}
@Override
public Condition getCondition() {
return condition;
}
@Override
public Map parameterMap(Object[] params) {
final var keys = statusParameterKeys;
// Almost all codes have zero or one parameters, so here is an un-nessesary micro optimisation for that case.
if (keys.length == 0 || params == null) {
return emptyMap();
} else if (keys.length == 1 && params.length > 0) {
return singletonMap(keys[0].name(), params[0]);
} else {
final var result = new HashMap(keys.length, 1.0f);
for (int i = 0; i < keys.length && i < params.length; i++) {
final var key = keys[i];
result.put(key.name(), params[i]);
}
return result;
}
}
@Override
public Map parameterMap(Map params) {
final var keys = statusParameterKeys;
// Almost all codes have zero or one parameters, so here is an un-nessesary micro optimisation for that case.
if (keys.length == 0 || params == null) {
return emptyMap();
} else if (keys.length == 1 && params.containsKey(keys[0])) {
return singletonMap(keys[0].name(), params.get(keys[0]));
} else {
final var result = new HashMap(statusParameterKeys.length, 1.0f);
for (int i = 0; i < statusParameterKeys.length; i++) {
final var key = statusParameterKeys[i];
result.put(key.name(), params.get(key));
}
return result;
}
}
@Override
public int parameterCount() {
return statusParameterKeys.length;
}
// Visible for testing
int messageFormatParameterCount() {
return messageFormat.parameterCount();
}
@Override
public List getStatusParameterKeys() {
return Collections.unmodifiableList(Arrays.asList(statusParameterKeys));
}
// In case of missing parameters (should not happen) we substitute with the param name to make message more readable
private Object[] populateMissingParams(Object[] params) {
if (params == null) params = new Object[0];
if (params.length >= statusParameterKeys.length) {
return params;
} else {
final var result = Arrays.copyOf(params, statusParameterKeys.length);
for (int i = params.length; i < result.length; ++i) result[i] = statusParameterKeys[i].toParamFormat();
return result;
}
}
private Object[] orderedParams(Map paramMap) {
if (paramMap == null) paramMap = emptyMap();
final var params = new Object[statusParameterKeys.length];
for (int i = 0; i < statusParameterKeys.length; ++i) {
final var key = statusParameterKeys[i];
params[i] = readbleValue(key, paramMap.get(key));
}
return params;
}
// In case of missing parameters (should not happen) we substitute with the param name to make message more
// readable.
private static Object readbleValue(GqlMessageParams param, Object value) {
return value != null ? value : param.toParamFormat();
}
}
class GqlStatusInfoCodeArgumentFormatter implements Function {
static final GqlStatusInfoCodeArgumentFormatter INSTANCE = new GqlStatusInfoCodeArgumentFormatter();
private GqlStatusInfoCodeArgumentFormatter() {}
@Override
public String apply(Object arg) {
if (arg == null || arg instanceof String || arg instanceof Boolean || arg instanceof Integer) {
return String.valueOf(arg);
} else if (isListOfString(arg)) {
//noinspection unchecked
return String.join(", ", ((List) arg));
} else {
// TODO I see no reason to throw an exception here when we could just fallback using toString.
// Kept it here for now to limit the scope of my PR.
throw new IllegalArgumentException(
"Expected parameter to be String, Boolean, Integer or List but was %s".formatted(arg));
}
}
private static boolean isListOfString(Object value) {
if (value instanceof List list) {
for (final var item : list) if (!(item instanceof String)) return false;
return true;
}
return false;
}
}