TcpCodecs factory Sonar polishing

- also some magic numbers in the deserializers

Author: garyrussell

spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/serializer/ByteArrayElasticRawDeserializer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2018 the original author or authors.
+ * Copyright 2017-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -34,14 +34,16 @@
  */
 public class ByteArrayElasticRawDeserializer implements Deserializer<byte[]> {
 
+	private static final int DEFAULT_INITIAL_SIZE = 32;
+
 	private final int initialBufferSize;
 
 	/**
 	 * Construct an instance that uses {@link ByteArrayOutputStream}s with an initial
 	 * buffer size of 32;
 	 */
 	public ByteArrayElasticRawDeserializer() {
-		this(32);
+		this(DEFAULT_INITIAL_SIZE);
 	}
 
 	/**

spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/serializer/ByteArrayLengthHeaderSerializer.java

@@ -45,21 +45,24 @@
  */
 public class ByteArrayLengthHeaderSerializer extends AbstractByteArraySerializer {
 
-
 	/**
 	 * Default length-header field, allows for data up to 2**31-1 bytes.
 	 */
-	public static final int HEADER_SIZE_INT = 4; // default
+	public static final int HEADER_SIZE_INT = Integer.BYTES; // default
 
 	/**
-	 * A single unsigned byte, for data up to 255 bytes.
+	 * An unsigned short, for data up to 2**16 bytes.
 	 */
-	public static final int HEADER_SIZE_UNSIGNED_BYTE = 1;
+	public static final int HEADER_SIZE_UNSIGNED_SHORT = Short.BYTES;
 
 	/**
-	 * An unsigned short, for data up to 2**16 bytes.
+	 * A single unsigned byte, for data up to 255 bytes.
 	 */
-	public static final int HEADER_SIZE_UNSIGNED_SHORT = 2;
+	public static final int HEADER_SIZE_UNSIGNED_BYTE = Byte.BYTES;
+
+	private static final int MAX_UNSIGNED_SHORT = 0xffff;
+
+	private static final int MAX_UNSIGNED_BYTE = 0xff;
 
 	private final int headerSize;
 
@@ -183,15 +186,15 @@ protected void writeHeader(OutputStream outputStream, int length) throws IOExcep
 				lengthPart.putInt(length);
 				break;
 			case HEADER_SIZE_UNSIGNED_BYTE:
-				if (length > 0xff) {
+				if (length > MAX_UNSIGNED_BYTE) {
 					throw new IllegalArgumentException("Length header:"
 							+ this.headerSize
 							+ " too short to accommodate message length:" + length);
 				}
 				lengthPart.put((byte) length);
 				break;
 			case HEADER_SIZE_UNSIGNED_SHORT:
-				if (length > 0xffff) {
+				if (length > MAX_UNSIGNED_SHORT) {
 					throw new IllegalArgumentException("Length header:"
 							+ this.headerSize
 							+ " too short to accommodate message length:" + length);
@@ -231,10 +234,10 @@ protected int readHeader(InputStream inputStream) throws IOException {
 					}
 					break;
 				case HEADER_SIZE_UNSIGNED_BYTE:
-					messageLength = ByteBuffer.wrap(lengthPart).get() & 0xff;
+					messageLength = ByteBuffer.wrap(lengthPart).get() & MAX_UNSIGNED_BYTE;
 					break;
 				case HEADER_SIZE_UNSIGNED_SHORT:
-					messageLength = ByteBuffer.wrap(lengthPart).getShort() & 0xffff;
+					messageLength = ByteBuffer.wrap(lengthPart).getShort() & MAX_UNSIGNED_SHORT;
 					break;
 				default:
 					throw new IllegalArgumentException("Bad header size:" + this.headerSize);

spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/serializer/ByteArrayLfSerializer.java

@@ -29,7 +29,7 @@ public class ByteArrayLfSerializer extends ByteArraySingleTerminatorSerializer {
 	public static final ByteArrayLfSerializer INSTANCE = new ByteArrayLfSerializer();
 
 	public ByteArrayLfSerializer() {
-		super((byte) 0x0a);
+		super((byte) '\n');
 	}
 
 }

spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/serializer/TcpCodecs.java

@@ -99,7 +99,7 @@ public static ByteArraySingleTerminatorSerializer singleTerminator(byte terminat
 	 */
 	public static ByteArrayLengthHeaderSerializer lengthHeader1() {
 		if (oneByteLHS == null) {
-			oneByteLHS = new ByteArrayLengthHeaderSerializer(1);
+			oneByteLHS = new ByteArrayLengthHeaderSerializer(ByteArrayLengthHeaderSerializer.HEADER_SIZE_UNSIGNED_BYTE);
 		}
 		return oneByteLHS;
 	}
@@ -111,7 +111,8 @@ public static ByteArrayLengthHeaderSerializer lengthHeader1() {
 	 */
 	public static ByteArrayLengthHeaderSerializer lengthHeader2() {
 		if (twoByteLHS == null) {
-			twoByteLHS = new ByteArrayLengthHeaderSerializer(2);
+			twoByteLHS = new ByteArrayLengthHeaderSerializer(
+					ByteArrayLengthHeaderSerializer.HEADER_SIZE_UNSIGNED_SHORT);
 		}
 		return twoByteLHS;
 	}
@@ -123,7 +124,7 @@ public static ByteArrayLengthHeaderSerializer lengthHeader2() {
 	 */
 	public static ByteArrayLengthHeaderSerializer lengthHeader4() {
 		if (fourByteLHS == null) {
-			fourByteLHS = new ByteArrayLengthHeaderSerializer(4);
+			fourByteLHS = new ByteArrayLengthHeaderSerializer(ByteArrayLengthHeaderSerializer.HEADER_SIZE_INT);
 		}
 		return fourByteLHS;
 	}
@@ -136,11 +137,11 @@ public static ByteArrayLengthHeaderSerializer lengthHeader4() {
 	 */
 	public static ByteArrayLengthHeaderSerializer lengthHeader(int bytes) {
 		switch (bytes) {
-		case 1:
+		case ByteArrayLengthHeaderSerializer.HEADER_SIZE_UNSIGNED_BYTE:
 			return lengthHeader1();
-		case 2:
+		case ByteArrayLengthHeaderSerializer.HEADER_SIZE_UNSIGNED_SHORT:
 			return lengthHeader2();
-		case 4:
+		case ByteArrayLengthHeaderSerializer.HEADER_SIZE_INT:
 			return lengthHeader4();
 		default:
 			throw new IllegalArgumentException("Only 1, 2 or 4 byte headers are supported");
@@ -216,7 +217,8 @@ public static ByteArraySingleTerminatorSerializer singleTerminator(byte terminat
 	 * @since 5.1.3
 	 */
 	public static ByteArrayLengthHeaderSerializer lengthHeader1(int maxMessageSize) {
-		ByteArrayLengthHeaderSerializer codec = new ByteArrayLengthHeaderSerializer(1);
+		ByteArrayLengthHeaderSerializer codec = new ByteArrayLengthHeaderSerializer(
+				ByteArrayLengthHeaderSerializer.HEADER_SIZE_UNSIGNED_BYTE);
 		codec.setMaxMessageSize(maxMessageSize);
 		return codec;
 	}
@@ -228,7 +230,8 @@ public static ByteArrayLengthHeaderSerializer lengthHeader1(int maxMessageSize)
 	 * @since 5.1.3
 	 */
 	public static ByteArrayLengthHeaderSerializer lengthHeader2(int maxMessageSize) {
-		ByteArrayLengthHeaderSerializer codec = new ByteArrayLengthHeaderSerializer(2);
+		ByteArrayLengthHeaderSerializer codec = new ByteArrayLengthHeaderSerializer(
+				ByteArrayLengthHeaderSerializer.HEADER_SIZE_UNSIGNED_SHORT);
 		codec.setMaxMessageSize(maxMessageSize);
 		return codec;
 	}
@@ -240,7 +243,8 @@ public static ByteArrayLengthHeaderSerializer lengthHeader2(int maxMessageSize)
 	 * @since 5.1.3
 	 */
 	public static ByteArrayLengthHeaderSerializer lengthHeader4(int maxMessageSize) {
-		ByteArrayLengthHeaderSerializer codec = new ByteArrayLengthHeaderSerializer(4);
+		ByteArrayLengthHeaderSerializer codec = new ByteArrayLengthHeaderSerializer(
+				ByteArrayLengthHeaderSerializer.HEADER_SIZE_INT);
 		codec.setMaxMessageSize(maxMessageSize);
 		return codec;
 	}