Skip to content

Commit dd80185

Browse files
arpan14arpan14
committed
docs:fix errors in documentation.
1 parent 7440131 commit dd80185

File tree

1 file changed

+102
-25
lines changed

1 file changed

+102
-25
lines changed

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/StructReader.java

Lines changed: 102 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -72,87 +72,164 @@ public interface StructReader {
7272
*/
7373
int getColumnIndex(String columnName);
7474

75-
/** Returns the type of a column. */
75+
/**
76+
* @param columnIndex
77+
* @return the type of a column.
78+
*/
7679
Type getColumnType(int columnIndex);
7780

78-
/** Returns the type of a column. */
81+
/**
82+
* @param columnName
83+
* @return the type of a column.
84+
*/
7985
Type getColumnType(String columnName);
8086

81-
/** Returns {@code true} if a column contains a {@code NULL} value. */
87+
/**
88+
* @param columnIndex
89+
* @return {@code true} if a column contains a {@code NULL} value.
90+
*/
8291
boolean isNull(int columnIndex);
8392

84-
/** Returns {@code true} if a column contains a {@code NULL} value. */
93+
/**
94+
* @param columnName
95+
* @return {@code true} if a column contains a {@code NULL} value.
96+
*/
8597
boolean isNull(String columnName);
8698

87-
/** Returns the value of a non-{@code NULL} column with type {@link Type#bool()}. */
99+
/**
100+
* @param columnIndex
101+
* @return the value of a non-{@code NULL} column with type {@link Type#bool()}.
102+
*/
88103
boolean getBoolean(int columnIndex);
89104

90-
/** Returns the value of a non-{@code NULL} column with type {@link Type#bool()}. */
105+
/**
106+
* @param columnName
107+
* @return the value of a non-{@code NULL} column with type {@link Type#bool()}.
108+
*/
91109
boolean getBoolean(String columnName);
92110

93-
/** Returns the value of a non-{@code NULL} column with type {@link Type#int64()}. */
111+
/**
112+
* @param columnIndex
113+
* @return the value of a non-{@code NULL} column with type {@link Type#int64()}.
114+
*/
94115
long getLong(int columnIndex);
95116

96-
/** Returns the value of a non-{@code NULL} column with type {@link Type#int64()}. */
117+
/**
118+
* @param columnName
119+
* @return the value of a non-{@code NULL} column with type {@link Type#int64()}.
120+
*/
97121
long getLong(String columnName);
98122

99-
/** Returns the value of a non-{@code NULL} column with type {@link Type#float64()}. */
123+
/**
124+
* @param columnIndex
125+
* @return the value of a non-{@code NULL} column with type {@link Type#float64()}.
126+
*/
100127
double getDouble(int columnIndex);
101128

102-
/** Returns the value of a non-{@code NULL} column with type {@link Type#float64()}. */
129+
/**
130+
* @param columnName
131+
* @return the value of a non-{@code NULL} column with type {@link Type#float64()}.
132+
*/
103133
double getDouble(String columnName);
104134

105-
/** Returns the value of a non-{@code NULL} column with type {@link Type#numeric()}. */
135+
/**
136+
* @param columnIndex
137+
* @return the value of a non-{@code NULL} column with type {@link Type#numeric()}.
138+
*/
106139
BigDecimal getBigDecimal(int columnIndex);
107140

108-
/** Returns the value of a non-{@code NULL} column with type {@link Type#numeric()}. */
141+
/**
142+
* @param columnName
143+
* @return the value of a non-{@code NULL} column with type {@link Type#numeric()}.
144+
*/
109145
BigDecimal getBigDecimal(String columnName);
110146

111-
/** Returns the value of a non-{@code NULL} column with type {@link Type#string()}. */
147+
/**
148+
* @param columnIndex
149+
* @return the value of a non-{@code NULL} column with type {@link Type#string()}.
150+
*/
112151
String getString(int columnIndex);
113152

114-
/** Returns the value of a non-{@code NULL} column with type {@link Type#string()}. */
153+
/**
154+
* @param columnName
155+
* @return the value of a non-{@code NULL} column with type {@link Type#string()}.
156+
*/
115157
String getString(String columnName);
116158

117-
/** Returns the value of a non-{@code NULL} column with type {@link Type#json()}. */
159+
/**
160+
*
161+
* @param columnIndex
162+
* @return the value of a non-{@code NULL} column with type {@link Type#json()}.
163+
*/
118164
default String getJson(int columnIndex) {
119165
throw new UnsupportedOperationException("method should be overwritten");
120166
}
121167

122-
/** Returns the value of a non-{@code NULL} column with type {@link Type#json()}. */
168+
/**
169+
* @param columnName
170+
* @return the value of a non-{@code NULL} column with type {@link Type#json()}.
171+
*/
123172
default String getJson(String columnName) {
124173
throw new UnsupportedOperationException("method should be overwritten");
125174
}
126175

127-
/** Returns the value of a non-{@code NULL} column with type {@link Type#pgJsonb()}. */
176+
/**
177+
*
178+
* @param columnIndex
179+
* @return the value of a non-{@code NULL} column with type {@link Type#pgJsonb()}.
180+
*/
128181
default String getPgJsonb(int columnIndex) {
129182
throw new UnsupportedOperationException("method should be overwritten");
130183
}
131184

132-
/** Returns the value of a non-{@code NULL} column with type {@link Type#pgJsonb()}. */
185+
/**
186+
* @param columnName
187+
* @return the value of a non-{@code NULL} column with type {@link Type#pgJsonb()}.
188+
*/
133189
default String getPgJsonb(String columnName) {
134190
throw new UnsupportedOperationException("method should be overwritten");
135191
}
136192

137-
/** Returns the value of a non-{@code NULL} column with type {@link Type#bytes()}. */
193+
/**
194+
* @param columnIndex
195+
* @return the value of a non-{@code NULL} column with type {@link Type#bytes()}.
196+
*/
138197
ByteArray getBytes(int columnIndex);
139198

140-
/** Returns the value of a non-{@code NULL} column with type {@link Type#bytes()}. */
199+
/**
200+
* @param columnName
201+
* @return the value of a non-{@code NULL} column with type {@link Type#bytes()}.
202+
*/
141203
ByteArray getBytes(String columnName);
142204

143-
/** Returns the value of a non-{@code NULL} column with type {@link Type#timestamp()}. */
205+
/**
206+
* @param columnIndex
207+
* @return the value of a non-{@code NULL} column with type {@link Type#timestamp()}.
208+
*/
144209
Timestamp getTimestamp(int columnIndex);
145210

146-
/** Returns the value of a non-{@code NULL} column with type {@link Type#timestamp()}. */
211+
/**
212+
* @param columnName
213+
* @return the value of a non-{@code NULL} column with type {@link Type#timestamp()}.
214+
*/
147215
Timestamp getTimestamp(String columnName);
148216

149-
/** Returns the value of a non-{@code NULL} column with type {@link Type#date()}. */
217+
/**
218+
* @param columnIndex
219+
* @return the value of a non-{@code NULL} column with type {@link Type#date()}.
220+
*/
150221
Date getDate(int columnIndex);
151222

152-
/** Returns the value of a non-{@code NULL} column with type {@link Type#date()}. */
223+
/**
224+
* @param columnName
225+
* @return the value of a non-{@code NULL} column with type {@link Type#date()}.
226+
*/
153227
Date getDate(String columnName);
154228

155-
/** Returns the value of a nullable column as a {@link Value}. */
229+
/**
230+
* @param columnIndex
231+
* @return the value of a nullable column as a {@link Value}.
232+
*/
156233
default Value getValue(int columnIndex) {
157234
throw new UnsupportedOperationException("method should be overwritten");
158235
}

0 commit comments

Comments
 (0)