aboutsummaryrefslogtreecommitdiffstats
path: root/src/com/iciql/util/StatementBuilder.java
blob: 65c06793eb28d28bccd92ddf3d46630462a16884 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/*
 * Copyright 2004-2011 H2 Group.
 * Copyright 2011 James Moger.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.iciql.util;

/**
 * A utility class to build a statement. In addition to the methods supported by
 * StringBuilder, it allows to add a text only in the second iteration. This
 * simplified constructs such as:
 * 
 * <pre>
 * StringBuilder buff = new StringBuilder();
 * for (int i = 0; i &lt; args.length; i++) {
 * 	if (i &gt; 0) {
 * 		buff.append(&quot;, &quot;);
 * 	}
 * 	buff.append(args[i]);
 * }
 * </pre>
 * 
 * to
 * 
 * <pre>
 * StatementBuilder buff = new StatementBuilder();
 * for (String s : args) {
 * 	buff.appendExceptFirst(&quot;, &quot;);
 * 	buff.append(a);
 * }
 * </pre>
 */
public class StatementBuilder {

	private final StringBuilder builder = new StringBuilder();
	private int index;

	/**
	 * Create a new builder.
	 */
	public StatementBuilder() {
		// nothing to do
	}

	/**
	 * Create a new builder.
	 * 
	 * @param string
	 *            the initial string
	 */
	public StatementBuilder(String string) {
		builder.append(string);
	}

	/**
	 * Append a text.
	 * 
	 * @param s
	 *            the text to append
	 * @return itself
	 */
	public StatementBuilder append(String s) {
		builder.append(s);
		return this;
	}

	/**
	 * Append a character.
	 * 
	 * @param c
	 *            the character to append
	 * @return itself
	 */
	public StatementBuilder append(char c) {
		builder.append(c);
		return this;
	}

	/**
	 * Append a number.
	 * 
	 * @param x
	 *            the number to append
	 * @return itself
	 */
	public StatementBuilder append(long x) {
		builder.append(x);
		return this;
	}
	
	/**
	 * Returns the current value of the loop counter.
	 * @return the loop counter
	 */
	public int getCount() {
		return index;
	}

	/**
	 * Reset the loop counter.
	 * 
	 * @return itself
	 */
	public StatementBuilder resetCount() {
		index = 0;
		return this;
	}

	/**
	 * Append a text, but only if appendExceptFirst was never called.
	 * 
	 * @param s
	 *            the text to append
	 */
	public void appendOnlyFirst(String s) {
		if (index == 0) {
			builder.append(s);
		}
	}

	/**
	 * Append a text, except when this method is called the first time.
	 * 
	 * @param s
	 *            the text to append
	 */
	public void appendExceptFirst(String s) {
		if (index++ > 0) {
			builder.append(s);
		}
	}

	public void append(StatementBuilder sb) {
		builder.append(sb);
	}

	public void insert(int offset, char c) {
		builder.insert(offset, c);
	}

	public String toString() {
		return builder.toString();
	}

	/**
	 * Get the length.
	 * 
	 * @return the length
	 */
	public int length() {
		return builder.length();
	}
}