source.dussan.org Git - vaadin-framework.git/blob

   1 /*
   2  * Copyright 2000-2018 Vaadin Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
   5  * use this file except in compliance with the License. You may obtain a copy of
   6  * the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  12  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13  * License for the specific language governing permissions and limitations under
  14  * the License.
  15  */
  16 package com.vaadin.v7.data.util.sqlcontainer.query.generator.filter;
  17
  18 import java.io.Serializable;
  19
  20 /**
  21  * The StringDecorator knows how to produce a quoted string using the specified
  22  * quote start and quote end characters. It also handles grouping of a string
  23  * (surrounding it in parenthesis).
  24  *
  25  * Extend this class if you need to support special characters for grouping
  26  * (parenthesis).
  27  *
  28  * @author Vaadin Ltd
  29  *
  30  * @deprecated As of 8.0, no replacement available.
  31  */
  32 @Deprecated
  33 public class StringDecorator implements Serializable {
  34
  35     private final String quoteStart;
  36     private final String quoteEnd;
  37
  38     /**
  39      * Constructs a StringDecorator that uses the quoteStart and quoteEnd
  40      * characters to create quoted strings.
  41      *
  42      * @param quoteStart
  43      *            the character denoting the start of a quote.
  44      * @param quoteEnd
  45      *            the character denoting the end of a quote.
  46      */
  47     public StringDecorator(String quoteStart, String quoteEnd) {
  48         this.quoteStart = quoteStart;
  49         this.quoteEnd = quoteEnd;
  50     }
  51
  52     /**
  53      * Surround a string with quote characters.
  54      *
  55      * @param str
  56      *            the string to quote
  57      * @return the quoted string
  58      */
  59     public String quote(Object str) {
  60         return quoteStart + str + quoteEnd;
  61     }
  62
  63     /**
  64      * Groups a string by surrounding it in parenthesis.
  65      *
  66      * @param str
  67      *            the string to group
  68      * @return the grouped string
  69      */
  70     public String group(String str) {
  71         return "(" + str + ")";
  72     }
  73 }