| /* |
| * Copyright (c) 2006, 2021 Oracle and/or its affiliates. All rights reserved. |
| * |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Public License v. 2.0 which is available at |
| * http://www.eclipse.org/legal/epl-2.0, |
| * or the Eclipse Distribution License v. 1.0 which is available at |
| * http://www.eclipse.org/org/documents/edl-v10.php. |
| * |
| * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause |
| */ |
| |
| // Contributors: |
| // Oracle - initial API and implementation |
| // |
| package org.eclipse.persistence.jpa.tests.jpql.parser; |
| |
| /** |
| * This formatter is used to format the real JPQL query that was parsed before it is compared to |
| * the string representation of the parsed tree, which can be different because the parsed tree |
| * does not keep track of multiple whitespace but only one. |
| * |
| * @version 2.3 |
| * @since 2.3 |
| * @author Pascal Filion |
| */ |
| public interface JPQLQueryStringFormatter { |
| |
| /** |
| * The default implementation of {@link JPQLQueryStringFormatter}, which returns the JPQL query |
| * without formatting it. |
| */ |
| JPQLQueryStringFormatter DEFAULT = new JPQLQueryStringFormatter() { |
| |
| @Override |
| public String format(String query) { |
| return query; |
| } |
| }; |
| |
| /** |
| * Formats the given JPQL query by changing its information, which is usually changing the |
| * number of whitespace between two non-whitespace characters. |
| * |
| * @param query The JPQL query to format |
| * @return The formatted JPQL query |
| */ |
| String format(String query); |
| } |