001/* 002 * (C) Copyright 2007 Nuxeo SAS (http://nuxeo.com/) and contributors. 003 * 004 * All rights reserved. This program and the accompanying materials 005 * are made available under the terms of the GNU Lesser General Public License 006 * (LGPL) version 2.1 which accompanies this distribution, and is available at 007 * http://www.gnu.org/licenses/lgpl.html 008 * 009 * This library is distributed in the hope that it will be useful, 010 * but WITHOUT ANY WARRANTY; without even the implied warranty of 011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 012 * Lesser General Public License for more details. 013 * 014 * Contributors: 015 * Nuxeo - initial API and implementation 016 * 017 * $Id$ 018 */ 019 020package org.nuxeo.ecm.core.search.api.client.querymodel; 021 022/** 023 * An interface for special character escaping in queries for easy configuration of this matter. 024 * <p> 025 * This is meant for the contents of string literals in where clauses, once they have been extracted. It's therefore not 026 * necessary to escape single quotes, unless of course they have some meaning to the search backend. 027 * </p> 028 * 029 * @author <a href="mailto:gracinet@nuxeo.com">Georges Racinet</a> 030 */ 031public interface Escaper { 032 033 /** 034 * Escapes the provided string 035 * 036 * @param s 037 * @return the escaped string 038 */ 039 String escape(String s); 040}