Skip to content

Commit 76d2ce5

Browse files
mjpt777mjpt777
committed
Rename Serializer and Deserializer to Encoder and Decoder to be in keeping with naming conventions.
1 parent 9c484c1 commit 76d2ce5

File tree

6 files changed

+84
-88
lines changed

6 files changed

+84
-88
lines changed

‎main/java/uk/co/real_logic/sbe/SbeTool.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818

1919
import uk.co.real_logic.sbe.generation.CodeGenerator;
2020
import uk.co.real_logic.sbe.generation.TargetCodeGenerator;
21-
import uk.co.real_logic.sbe.ir.Deserializer;
21+
import uk.co.real_logic.sbe.ir.Decoder;
22+
import uk.co.real_logic.sbe.ir.Encoder;
2223
import uk.co.real_logic.sbe.ir.IntermediateRepresentation;
23-
import uk.co.real_logic.sbe.ir.Serializer;
2424
import uk.co.real_logic.sbe.xml.IrGenerator;
2525
import uk.co.real_logic.sbe.xml.MessageSchema;
2626
import uk.co.real_logic.sbe.xml.XmlSchemaParser;
@@ -50,7 +50,7 @@
5050
* <li><code>sbe.should.generate</code>: Generate or not. Defaults to true</li>
5151
* <li><code>sbe.target.language</code>: Target language for code generation, defaults to Java.</li>
5252
* <li><code>sbe.output.dir</code>: Target directory for code generation, defaults to current directory.</li>
53-
* <li><code>sbe.ir.filename</code>: Filename to serialize IR to within the output directory.</li>
53+
* <li><code>sbe.ir.filename</code>: Filename to encode IR to within the output directory.</li>
5454
* </ul>
5555
*/
5656
public class SbeTool
@@ -103,7 +103,7 @@ public static void main(final String[] args) throws Exception
103103
}
104104
else if (fileName.endsWith(".sbeir"))
105105
{
106-
ir = new Deserializer(fileName).deserialize();
106+
ir = new Decoder(fileName).decode();
107107
}
108108
else
109109
{
@@ -125,9 +125,9 @@ else if (fileName.endsWith(".sbeir"))
125125
final String outputDirName = System.getProperty(OUTPUT_DIR, ".");
126126
final File fullPath = new File(outputDirName, serializedIrFilename);
127127

128-
try (final Serializer serializer = new Serializer(fullPath.getAbsolutePath(), ir))
128+
try (final Encoder encoder = new Encoder(fullPath.getAbsolutePath(), ir))
129129
{
130-
serializer.serialize();
130+
encoder.encode();
131131
}
132132
}
133133
}

‎main/java/uk/co/real_logic/sbe/ir/Deserializer.java‎ renamed to ‎main/java/uk/co/real_logic/sbe/ir/Decoder.java‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import java.util.ArrayList;
2828
import java.util.List;
2929

30-
public class Deserializer implements Closeable
30+
public class Decoder implements Closeable
3131
{
3232
private static final int CAPACITY = 4096;
3333

@@ -43,7 +43,7 @@ public class Deserializer implements Closeable
4343
private final byte[] valArray = new byte[CAPACITY];
4444
private final DirectBuffer valBuffer = new DirectBuffer(valArray);
4545

46-
public Deserializer(final String fileName)
46+
public Decoder(final String fileName)
4747
throws IOException
4848
{
4949
channel = new RandomAccessFile(fileName, "r").getChannel();
@@ -53,7 +53,7 @@ public Deserializer(final String fileName)
5353
offset = 0;
5454
}
5555

56-
public Deserializer(final ByteBuffer buffer)
56+
public Decoder(final ByteBuffer buffer)
5757
{
5858
channel = null;
5959
size = buffer.limit();
@@ -70,15 +70,15 @@ public void close()
7070
}
7171
}
7272

73-
public IntermediateRepresentation deserialize()
73+
public IntermediateRepresentation decode()
7474
throws IOException
7575
{
76-
deserializeFrame();
76+
decodeFrame();
7777

7878
final List<Token> tokens = new ArrayList<>();
7979
while (offset < size)
8080
{
81-
tokens.add(deserializeToken());
81+
tokens.add(decodeToken());
8282
}
8383

8484
int i = 0, size = tokens.size();
@@ -137,7 +137,7 @@ private int captureMessage(final List<Token> tokens, int index, final Intermedia
137137
return index;
138138
}
139139

140-
private void deserializeFrame()
140+
private void decodeFrame()
141141
{
142142
serializedFrame.wrapForDecode(directBuffer, offset, serializedFrame.blockLength(), 0);
143143

@@ -155,7 +155,7 @@ private void deserializeFrame()
155155
offset += serializedFrame.size();
156156
}
157157

158-
private Token deserializeToken()
158+
private Token decodeToken()
159159
throws UnsupportedEncodingException
160160
{
161161
final Token.Builder tokenBuilder = new Token.Builder();
@@ -169,19 +169,19 @@ private Token deserializeToken()
169169
.size(serializedToken.tokenSize())
170170
.schemaId(serializedToken.schemaID())
171171
.version(serializedToken.tokenVersion())
172-
.signal(SerializationUtils.signal(serializedToken.signal()));
172+
.signal(IrCodecUtils.signal(serializedToken.signal()));
173173

174-
final PrimitiveType type = SerializationUtils.primitiveType(serializedToken.primitiveType());
174+
final PrimitiveType type = IrCodecUtils.primitiveType(serializedToken.primitiveType());
175175

176176
encBuilder.primitiveType(type)
177-
.byteOrder(SerializationUtils.byteOrder(serializedToken.byteOrder()));
177+
.byteOrder(IrCodecUtils.byteOrder(serializedToken.byteOrder()));
178178

179179
tokenBuilder.name(new String(byteArray, 0, serializedToken.getName(byteArray, 0, byteArray.length), SerializedToken.nameCharacterEncoding()));
180180

181-
encBuilder.constVal(SerializationUtils.getVal(valBuffer, type, serializedToken.getConstVal(valArray, 0, valArray.length)));
182-
encBuilder.minVal(SerializationUtils.getVal(valBuffer, type, serializedToken.getMinVal(valArray, 0, valArray.length)));
183-
encBuilder.maxVal(SerializationUtils.getVal(valBuffer, type, serializedToken.getMaxVal(valArray, 0, valArray.length)));
184-
encBuilder.nullVal(SerializationUtils.getVal(valBuffer, type, serializedToken.getNullVal(valArray, 0, valArray.length)));
181+
encBuilder.constVal(IrCodecUtils.getVal(valBuffer, type, serializedToken.getConstVal(valArray, 0, valArray.length)));
182+
encBuilder.minVal(IrCodecUtils.getVal(valBuffer, type, serializedToken.getMinVal(valArray, 0, valArray.length)));
183+
encBuilder.maxVal(IrCodecUtils.getVal(valBuffer, type, serializedToken.getMaxVal(valArray, 0, valArray.length)));
184+
encBuilder.nullVal(IrCodecUtils.getVal(valBuffer, type, serializedToken.getNullVal(valArray, 0, valArray.length)));
185185

186186
final int charEncodingSize = serializedToken.getCharacterEncoding(byteArray, 0, byteArray.length);
187187
encBuilder.characterEncoding(new String(byteArray, 0, charEncodingSize, SerializedToken.characterEncodingCharacterEncoding()));

‎main/java/uk/co/real_logic/sbe/ir/Serializer.java‎ renamed to ‎main/java/uk/co/real_logic/sbe/ir/Encoder.java‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import java.nio.channels.FileChannel;
2727
import java.util.List;
2828

29-
public class Serializer implements Closeable
29+
public class Encoder implements Closeable
3030
{
3131
private static final int CAPACITY = 4096;
3232

@@ -41,7 +41,7 @@ public class Serializer implements Closeable
4141
private final DirectBuffer valBuffer = new DirectBuffer(valArray);
4242
private int totalSize = 0;
4343

44-
public Serializer(final String fileName, final IntermediateRepresentation ir)
44+
public Encoder(final String fileName, final IntermediateRepresentation ir)
4545
throws FileNotFoundException
4646
{
4747
channel = new FileOutputStream(fileName).getChannel();
@@ -51,7 +51,7 @@ public Serializer(final String fileName, final IntermediateRepresentation ir)
5151
this.ir = ir;
5252
}
5353

54-
public Serializer(final ByteBuffer buffer, final IntermediateRepresentation ir)
54+
public Encoder(final ByteBuffer buffer, final IntermediateRepresentation ir)
5555
{
5656
channel = null;
5757
resultBuffer = buffer;
@@ -69,29 +69,29 @@ public void close()
6969
}
7070
}
7171

72-
public int serialize()
72+
public int encode()
7373
throws IOException
7474
{
7575
Verify.notNull(ir, "ir");
7676

77-
write(buffer, serializeFrame());
77+
write(buffer, encodeFrame());
7878

79-
serializeTokenList(ir.messageHeader().tokens());
79+
encodeTokenList(ir.messageHeader().tokens());
8080

8181
for (final List<Token> tokenList : ir.messages())
8282
{
83-
serializeTokenList(tokenList);
83+
encodeTokenList(tokenList);
8484
}
8585

8686
return totalSize;
8787
}
8888

89-
private void serializeTokenList(final List<Token> tokenList)
89+
private void encodeTokenList(final List<Token> tokenList)
9090
throws IOException
9191
{
9292
for (final Token token : tokenList)
9393
{
94-
write(buffer, serializeToken(token));
94+
write(buffer, encodeToken(token));
9595
}
9696
}
9797

@@ -113,7 +113,7 @@ else if (resultBuffer != null)
113113
totalSize += size;
114114
}
115115

116-
private int serializeFrame()
116+
private int encodeFrame()
117117
{
118118
serializedFrame.wrapForEncode(directBuffer, 0)
119119
.sbeIrVersion(0)
@@ -124,7 +124,7 @@ private int serializeFrame()
124124
return serializedFrame.size();
125125
}
126126

127-
private int serializeToken(final Token token)
127+
private int encodeToken(final Token token)
128128
throws UnsupportedEncodingException
129129
{
130130
final PrimitiveType type = token.encoding().primitiveType();
@@ -134,16 +134,16 @@ private int serializeToken(final Token token)
134134
.tokenSize(token.size())
135135
.schemaID(token.schemaId())
136136
.tokenVersion(token.version())
137-
.signal(SerializationUtils.signal(token.signal()))
138-
.primitiveType(SerializationUtils.primitiveType(type))
139-
.byteOrder(SerializationUtils.byteOrder(token.encoding().byteOrder()));
137+
.signal(IrCodecUtils.signal(token.signal()))
138+
.primitiveType(IrCodecUtils.primitiveType(type))
139+
.byteOrder(IrCodecUtils.byteOrder(token.encoding().byteOrder()));
140140

141141
serializedToken.putName(token.name().getBytes(), 0, token.name().getBytes(SerializedToken.nameCharacterEncoding()).length);
142142

143-
serializedToken.putConstVal(valArray, 0, SerializationUtils.putVal(valBuffer, token.encoding().constVal(), type));
144-
serializedToken.putMinVal(valArray, 0, SerializationUtils.putVal(valBuffer, token.encoding().minVal(), type));
145-
serializedToken.putMaxVal(valArray, 0, SerializationUtils.putVal(valBuffer, token.encoding().maxVal(), type));
146-
serializedToken.putNullVal(valArray, 0, SerializationUtils.putVal(valBuffer, token.encoding().nullVal(), type));
143+
serializedToken.putConstVal(valArray, 0, IrCodecUtils.putVal(valBuffer, token.encoding().constVal(), type));
144+
serializedToken.putMinVal(valArray, 0, IrCodecUtils.putVal(valBuffer, token.encoding().minVal(), type));
145+
serializedToken.putMaxVal(valArray, 0, IrCodecUtils.putVal(valBuffer, token.encoding().maxVal(), type));
146+
serializedToken.putNullVal(valArray, 0, IrCodecUtils.putVal(valBuffer, token.encoding().nullVal(), type));
147147

148148
final String charEncodingCharEncoding = SerializedToken.characterEncodingCharacterEncoding();
149149
final String charEncoding = token.encoding().characterEncoding();

‎main/java/uk/co/real_logic/sbe/ir/SerializationUtils.java‎ renamed to ‎main/java/uk/co/real_logic/sbe/ir/IrCodecUtils.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
import java.nio.ByteOrder;
2727

28-
public class SerializationUtils
28+
public class IrCodecUtils
2929
{
3030
public static SerializedByteOrder byteOrder(final ByteOrder byteOrder)
3131
{

‎main/resources/sbe-ir.xml‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,6 @@
33
description="SBE IR Serialization"
44
version="0"
55
byteOrder="littleEndian">
6-
<!--
7-
IR serialization
8-
-->
9-
106
<types>
117
<composite name="messageHeader">
128
<type name="blockLength" primitiveType="uint16"/>

0 commit comments

Comments
 (0)