View Javadoc
1   /*
2    * Copyright 2024 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    *      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,
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  
17  package org.bremersee.comparator.model;
18  
19  import org.immutables.value.Value;
20  
21  /**
22   * The sort order text separators.
23   *
24   * @author Christian Bremer
25   */
26  @Value.Immutable
27  public interface SortOrderTextSeparators {
28  
29    /**
30     * Gets argument separator.
31     *
32     * @return the argument separator
33     */
34    @Value.Default
35    default String getArgumentSeparator() {
36      return SortOrderItem.DEFAULT_SEPARATOR;
37    }
38  
39    /**
40     * Gets chain separator.
41     *
42     * @return the chain separator
43     */
44    @Value.Default
45    default String getChainSeparator() {
46      return SortOrder.DEFAULT_SEPARATOR;
47    }
48  
49    /**
50     * Default text separators.
51     *
52     * @return the default text separators
53     */
54    static SortOrderTextSeparators defaults() {
55      return builder().build();
56    }
57  
58    /**
59     * The immutable builder.
60     *
61     * @return the immutable builder
62     */
63    static ImmutableSortOrderTextSeparators.Builder builder() {
64      return ImmutableSortOrderTextSeparators.builder();
65    }
66  
67  }