001/*
002 * (C) Copyright 2007 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 * $Id$
020 */
021
022package org.nuxeo.ecm.core.search.api.client.querymodel;
023
024/**
025 * An interface for special character escaping in queries for easy configuration of this matter.
026 * <p>
027 * This is meant for the contents of string literals in where clauses, once they have been extracted. It's therefore not
028 * necessary to escape single quotes, unless of course they have some meaning to the search backend.
029 * </p>
030 *
031 * @author <a href="mailto:gracinet@nuxeo.com">Georges Racinet</a>
032 */
033public interface Escaper {
034
035    /**
036     * Escapes the provided string
037     *
038     * @return the escaped string
039     */
040    String escape(String s);
041}