View Javadoc
1   /*
2    *    Copyright 2016-2025 the original author or authors.
3    *
4    *    Licensed under the Apache License, Version 2.0 (the "License");
5    *    you may not use this file except in compliance with the License.
6    *    You may obtain a copy of the License at
7    *
8    *       https://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,
12   *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *    See the License for the specific language governing permissions and
14   *    limitations under the License.
15   */
16  package org.mybatis.dynamic.sql;
17  
18  import java.util.Objects;
19  import java.util.Optional;
20  
21  import org.jspecify.annotations.Nullable;
22  import org.mybatis.dynamic.sql.render.RenderingContext;
23  import org.mybatis.dynamic.sql.util.FragmentAndParameters;
24  import org.mybatis.dynamic.sql.util.StringUtilities;
25  
26  public class StringConstant implements BindableColumn<String> {
27  
28      private final @Nullable String alias;
29      private final String value;
30  
31      private StringConstant(String value) {
32          this(value, null);
33      }
34  
35      private StringConstant(String value, @Nullable String alias) {
36          this.value = Objects.requireNonNull(value);
37          this.alias = alias;
38      }
39  
40      @Override
41      public Optional<String> alias() {
42          return Optional.ofNullable(alias);
43      }
44  
45      @Override
46      public FragmentAndParameters render(RenderingContext renderingContext) {
47          return FragmentAndParameters.fromFragment(StringUtilities.formatConstantForSQL(value));
48      }
49  
50      @Override
51      public StringConstant as(String alias) {
52          return new StringConstant(value, alias);
53      }
54  
55      public static StringConstant of(String value) {
56          return new StringConstant(value);
57      }
58  }