Skip to content

Commit ed14931

Browse files
sancarwebashutosh
sancar
authored and
webashutosh
committed
Adds Nullable and Nonnull annotations to GenericRecord (hazelcast#17411)
adds Nullable and Nonnull annotations to GenericRecord add more javadoc for cloneWithBuilder add more javadoc to getFieldType
1 parent 2b0f390 commit ed14931

File tree

5 files changed

+164
-111
lines changed

5 files changed

+164
-111
lines changed

‎hazelcast/src/main/java/com/hazelcast/internal/serialization/impl/portable/PortableGenericRecord.java‎

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -41,123 +41,126 @@ public ClassDefinition getClassDefinition() {
4141
return classDefinition;
4242
}
4343

44+
@Nonnull
4445
@Override
4546
public Builder newBuilder() {
4647
return Builder.portable(classDefinition);
4748
}
4849

50+
@Nonnull
4951
@Override
5052
public Builder cloneWithBuilder() {
5153
return new PortableGenericRecordBuilder(classDefinition, Arrays.copyOf(objects, objects.length));
5254
}
5355

5456
@Override
55-
public GenericRecord[] readGenericRecordArray(String fieldName) {
57+
public GenericRecord[] readGenericRecordArray(@Nonnull String fieldName) {
5658
return read(fieldName, FieldType.PORTABLE_ARRAY);
5759
}
5860

5961
@Override
60-
public GenericRecord readGenericRecord(String fieldName) {
62+
public GenericRecord readGenericRecord(@Nonnull String fieldName) {
6163
return read(fieldName, FieldType.PORTABLE);
6264
}
6365

6466
@Override
65-
public boolean hasField(String fieldName) {
67+
public boolean hasField(@Nonnull String fieldName) {
6668
return classDefinition.hasField(fieldName);
6769
}
6870

6971
@Override
70-
public FieldType getFieldType(String fieldName) {
72+
@Nonnull
73+
public FieldType getFieldType(@Nonnull String fieldName) {
7174
return classDefinition.getFieldType(fieldName);
7275
}
7376

7477
@Override
75-
public boolean readBoolean(String fieldName) {
78+
public boolean readBoolean(@Nonnull String fieldName) {
7679
return read(fieldName, FieldType.BOOLEAN);
7780
}
7881

7982
@Override
80-
public byte readByte(String fieldName) {
83+
public byte readByte(@Nonnull String fieldName) {
8184
return read(fieldName, FieldType.BYTE);
8285
}
8386

8487
@Override
85-
public char readChar(String fieldName) {
88+
public char readChar(@Nonnull String fieldName) {
8689
return read(fieldName, FieldType.CHAR);
8790
}
8891

8992
@Override
90-
public double readDouble(String fieldName) {
93+
public double readDouble(@Nonnull String fieldName) {
9194
return read(fieldName, FieldType.DOUBLE);
9295
}
9396

9497
@Override
95-
public float readFloat(String fieldName) {
98+
public float readFloat(@Nonnull String fieldName) {
9699
return read(fieldName, FieldType.FLOAT);
97100
}
98101

99102
@Override
100-
public int readInt(String fieldName) {
103+
public int readInt(@Nonnull String fieldName) {
101104
return read(fieldName, FieldType.INT);
102105
}
103106

104107
@Override
105-
public long readLong(String fieldName) {
108+
public long readLong(@Nonnull String fieldName) {
106109
return read(fieldName, FieldType.LONG);
107110
}
108111

109112
@Override
110-
public short readShort(String fieldName) {
113+
public short readShort(@Nonnull String fieldName) {
111114
return read(fieldName, FieldType.SHORT);
112115
}
113116

114117
@Override
115-
public String readUTF(String fieldName) {
118+
public String readUTF(@Nonnull String fieldName) {
116119
return read(fieldName, FieldType.UTF);
117120
}
118121

119122
@Override
120-
public boolean[] readBooleanArray(String fieldName) {
123+
public boolean[] readBooleanArray(@Nonnull String fieldName) {
121124
return read(fieldName, FieldType.BOOLEAN_ARRAY);
122125
}
123126

124127
@Override
125-
public byte[] readByteArray(String fieldName) {
128+
public byte[] readByteArray(@Nonnull String fieldName) {
126129
return read(fieldName, FieldType.BYTE_ARRAY);
127130
}
128131

129132
@Override
130-
public char[] readCharArray(String fieldName) {
133+
public char[] readCharArray(@Nonnull String fieldName) {
131134
return read(fieldName, FieldType.CHAR_ARRAY);
132135
}
133136

134137
@Override
135-
public double[] readDoubleArray(String fieldName) {
138+
public double[] readDoubleArray(@Nonnull String fieldName) {
136139
return read(fieldName, FieldType.DOUBLE_ARRAY);
137140
}
138141

139142
@Override
140-
public float[] readFloatArray(String fieldName) {
143+
public float[] readFloatArray(@Nonnull String fieldName) {
141144
return read(fieldName, FieldType.FLOAT_ARRAY);
142145
}
143146

144147
@Override
145-
public int[] readIntArray(String fieldName) {
148+
public int[] readIntArray(@Nonnull String fieldName) {
146149
return read(fieldName, FieldType.INT_ARRAY);
147150
}
148151

149152
@Override
150-
public long[] readLongArray(String fieldName) {
153+
public long[] readLongArray(@Nonnull String fieldName) {
151154
return read(fieldName, FieldType.LONG_ARRAY);
152155
}
153156

154157
@Override
155-
public short[] readShortArray(String fieldName) {
158+
public short[] readShortArray(@Nonnull String fieldName) {
156159
return read(fieldName, FieldType.SHORT_ARRAY);
157160
}
158161

159162
@Override
160-
public String[] readUTFArray(String fieldName) {
163+
public String[] readUTFArray(@Nonnull String fieldName) {
161164
return read(fieldName, FieldType.UTF_ARRAY);
162165
}
163166

‎hazelcast/src/main/java/com/hazelcast/internal/serialization/impl/portable/PortableGenericRecordBuilder.java‎

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ public PortableGenericRecordBuilder(ClassDefinition classDefinition) {
5252
* {@link GenericRecord.Builder#portable(ClassDefinition)} and
5353
* {@link GenericRecord#newBuilder()}
5454
*/
55+
@Nonnull
5556
@Override
5657
public GenericRecord build() {
5758
if (!isClone) {
@@ -66,106 +67,106 @@ public GenericRecord build() {
6667
}
6768

6869
@Override
69-
public GenericRecord.Builder writeInt(String fieldName, int value) {
70+
public GenericRecord.Builder writeInt(@Nonnull String fieldName, int value) {
7071
return write(fieldName, value, FieldType.INT);
7172
}
7273

7374
@Override
74-
public GenericRecord.Builder writeLong(String fieldName, long value) {
75+
public GenericRecord.Builder writeLong(@Nonnull String fieldName, long value) {
7576
return write(fieldName, value, FieldType.LONG);
7677
}
7778

7879
@Override
79-
public GenericRecord.Builder writeUTF(String fieldName, String value) {
80+
public GenericRecord.Builder writeUTF(@Nonnull String fieldName, String value) {
8081
return write(fieldName, value, FieldType.UTF);
8182
}
8283

8384
@Override
84-
public GenericRecord.Builder writeBoolean(String fieldName, boolean value) {
85+
public GenericRecord.Builder writeBoolean(@Nonnull String fieldName, boolean value) {
8586
return write(fieldName, value, FieldType.BOOLEAN);
8687
}
8788

8889
@Override
89-
public GenericRecord.Builder writeByte(String fieldName, byte value) {
90+
public GenericRecord.Builder writeByte(@Nonnull String fieldName, byte value) {
9091
return write(fieldName, value, FieldType.BYTE);
9192
}
9293

9394
@Override
94-
public GenericRecord.Builder writeChar(String fieldName, char value) {
95+
public GenericRecord.Builder writeChar(@Nonnull String fieldName, char value) {
9596
return write(fieldName, value, FieldType.CHAR);
9697
}
9798

9899
@Override
99-
public GenericRecord.Builder writeDouble(String fieldName, double value) {
100+
public GenericRecord.Builder writeDouble(@Nonnull String fieldName, double value) {
100101
return write(fieldName, value, FieldType.DOUBLE);
101102
}
102103

103104
@Override
104-
public GenericRecord.Builder writeFloat(String fieldName, float value) {
105+
public GenericRecord.Builder writeFloat(@Nonnull String fieldName, float value) {
105106
return write(fieldName, value, FieldType.FLOAT);
106107
}
107108

108109
@Override
109-
public GenericRecord.Builder writeShort(String fieldName, short value) {
110+
public GenericRecord.Builder writeShort(@Nonnull String fieldName, short value) {
110111
return write(fieldName, value, FieldType.SHORT);
111112
}
112113

113114
@Override
114-
public GenericRecord.Builder writeGenericRecord(String fieldName, @Nullable GenericRecord value) {
115+
public GenericRecord.Builder writeGenericRecord(@Nonnull String fieldName, @Nullable GenericRecord value) {
115116
return write(fieldName, value, FieldType.PORTABLE);
116117
}
117118

118119
@Override
119-
public GenericRecord.Builder writeGenericRecordArray(String fieldName, GenericRecord[] value) {
120+
public GenericRecord.Builder writeGenericRecordArray(@Nonnull String fieldName, GenericRecord[] value) {
120121
return write(fieldName, value, FieldType.PORTABLE_ARRAY);
121122
}
122123

123124
@Override
124-
public GenericRecord.Builder writeByteArray(String fieldName, byte[] value) {
125+
public GenericRecord.Builder writeByteArray(@Nonnull String fieldName, byte[] value) {
125126
return write(fieldName, value, FieldType.BYTE_ARRAY);
126127
}
127128

128129
@Override
129-
public GenericRecord.Builder writeBooleanArray(String fieldName, boolean[] value) {
130+
public GenericRecord.Builder writeBooleanArray(@Nonnull String fieldName, boolean[] value) {
130131
return write(fieldName, value, FieldType.BOOLEAN_ARRAY);
131132
}
132133

133134
@Override
134-
public GenericRecord.Builder writeCharArray(String fieldName, char[] value) {
135+
public GenericRecord.Builder writeCharArray(@Nonnull String fieldName, char[] value) {
135136
return write(fieldName, value, FieldType.CHAR_ARRAY);
136137
}
137138

138139
@Override
139-
public GenericRecord.Builder writeIntArray(String fieldName, int[] value) {
140+
public GenericRecord.Builder writeIntArray(@Nonnull String fieldName, int[] value) {
140141
return write(fieldName, value, FieldType.INT_ARRAY);
141142
}
142143

143144
@Override
144-
public GenericRecord.Builder writeLongArray(String fieldName, long[] value) {
145+
public GenericRecord.Builder writeLongArray(@Nonnull String fieldName, long[] value) {
145146
return write(fieldName, value, FieldType.LONG_ARRAY);
146147
}
147148

148149
@Override
149-
public GenericRecord.Builder writeDoubleArray(String fieldName, double[] value) {
150+
public GenericRecord.Builder writeDoubleArray(@Nonnull String fieldName, double[] value) {
150151
return write(fieldName, value, FieldType.DOUBLE_ARRAY);
151152
}
152153

153154
@Override
154-
public GenericRecord.Builder writeFloatArray(String fieldName, float[] value) {
155+
public GenericRecord.Builder writeFloatArray(@Nonnull String fieldName, float[] value) {
155156
return write(fieldName, value, FieldType.FLOAT_ARRAY);
156157
}
157158

158159
@Override
159-
public GenericRecord.Builder writeShortArray(String fieldName, short[] value) {
160+
public GenericRecord.Builder writeShortArray(@Nonnull String fieldName, short[] value) {
160161
return write(fieldName, value, FieldType.SHORT_ARRAY);
161162
}
162163

163164
@Override
164-
public GenericRecord.Builder writeUTFArray(String fieldName, String[] value) {
165+
public GenericRecord.Builder writeUTFArray(@Nonnull String fieldName, String[] value) {
165166
return write(fieldName, value, FieldType.UTF_ARRAY);
166167
}
167168

168-
private GenericRecord.Builder write(String fieldName, Object value, FieldType fieldType) {
169+
private GenericRecord.Builder write(@Nonnull String fieldName, Object value, FieldType fieldType) {
169170
FieldDefinition fd = check(fieldName, fieldType);
170171
int index = fd.getIndex();
171172
if (isWritten[index]) {
@@ -181,7 +182,7 @@ private GenericRecord.Builder write(String fieldName, Object value, FieldType fi
181182
}
182183

183184
@Nonnull
184-
private FieldDefinition check(String fieldName, FieldType fieldType) {
185+
private FieldDefinition check(@Nonnull String fieldName, FieldType fieldType) {
185186
FieldDefinition fd = classDefinition.getField(fieldName);
186187
if (fd == null) {
187188
throw new HazelcastSerializationException("Invalid field name: '" + fieldName

0 commit comments

Comments
 (0)