Consider adding a doc comment for putByte
10 private byte[] intBuffer = new byte[4];
11 private byte[] longBuffer = new byte[8];
12
13 public synchronized void putByte(byte val) throws IOException {14 byteBuffer[0] = (byte) (val >>> 8);15 write(byteBuffer);16 }17
18 public synchronized void putBoolean(boolean val) throws IOException {
19 byteBuffer[0] = (byte) (val ? 1 : 0);Consider adding a doc comment for putBoolean
15 write(byteBuffer);
16 }
17
18 public synchronized void putBoolean(boolean val) throws IOException {19 byteBuffer[0] = (byte) (val ? 1 : 0);20 write(byteBuffer);21 }22
23 public synchronized void putChar(char val) throws IOException {
24 shortBuffer[1] = (byte) (val >>> 8);Consider adding a doc comment for putChar
20 write(byteBuffer);
21 }
22
23 public synchronized void putChar(char val) throws IOException {24 shortBuffer[1] = (byte) (val >>> 8);25 shortBuffer[0] = (byte) (val);26 write(shortBuffer);27 }28
29 public synchronized void putShort(short val) throws IOException {
30 shortBuffer[1] = (byte) (val >>> 8);Consider adding a doc comment for putShort
26 write(shortBuffer);
27 }
28
29 public synchronized void putShort(short val) throws IOException {30 shortBuffer[1] = (byte) (val >>> 8);31 shortBuffer[0] = (byte) (val);32 write(shortBuffer);33 }34
35 public synchronized void putInt(int val) throws IOException {
36 intBuffer[3] = (byte) (val >>> 24);Consider adding a doc comment for putInt
32 write(shortBuffer);
33 }
34
35 public synchronized void putInt(int val) throws IOException {36 intBuffer[3] = (byte) (val >>> 24);37 intBuffer[2] = (byte) (val >>> 16);38 intBuffer[1] = (byte) (val >>> 8);39 intBuffer[0] = (byte) (val);40 write(intBuffer);41 }42
43 public synchronized void putFloat(float val) throws IOException {
44 putInt(Float.floatToIntBits(val));Consider adding a doc comment for putFloat
40 write(intBuffer);
41 }
42
43 public synchronized void putFloat(float val) throws IOException {44 putInt(Float.floatToIntBits(val));45 }46
47 public synchronized void putLong(long val) throws IOException {
48 longBuffer[7] = (byte) (val >>> 56);Consider adding a doc comment for putLong
44 putInt(Float.floatToIntBits(val));
45 }
46
47 public synchronized void putLong(long val) throws IOException {48 longBuffer[7] = (byte) (val >>> 56);49 longBuffer[6] = (byte) (val >>> 48);50 longBuffer[5] = (byte) (val >>> 40);51 longBuffer[4] = (byte) (val >>> 32);52 longBuffer[3] = (byte) (val >>> 24);53 longBuffer[2] = (byte) (val >>> 16);54 longBuffer[1] = (byte) (val >>> 8);55 longBuffer[0] = (byte) (val);56 write(longBuffer);57 }58
59 public synchronized void putDouble(double val) throws IOException {
60 putLong(Double.doubleToLongBits(val));Consider adding a doc comment for putDouble
56 write(longBuffer);
57 }
58
59 public synchronized void putDouble(double val) throws IOException {60 putLong(Double.doubleToLongBits(val));61 }62
63}Consider adding a doc comment for readLong
48 return Float.intBitsToFloat(readInt());
49 }
50
51 public synchronized long readLong() throws IOException {52 read(tmpBuffer, 0, 8);5354 return ((tmpBuffer[0] & 0xFFL)) + ((tmpBuffer[1] & 0xFFL) << 8) + ((tmpBuffer[2] & 0xFFL) << 16)55 + ((tmpBuffer[3] & 0xFFL) << 24) + ((tmpBuffer[4] & 0xFFL) << 32) + ((tmpBuffer[5] & 0xFFL) << 40)56 + ((tmpBuffer[6] & 0xFFL) << 48) + (((long) tmpBuffer[7]) << 56);57 }58
59 public synchronized double readDouble(double val) throws IOException {
60 return Double.doubleToLongBits(readLong());Consider adding a doc comment for readInt
37 return (short) ((tmpBuffer[0] & 0xFF) + (tmpBuffer[1] << 8));
38 }
39
40 public synchronized int readInt() throws IOException {41 read(tmpBuffer, 0, 4);4243 return ((tmpBuffer[0] & 0xFF)) + ((tmpBuffer[1] & 0xFF) << 8) + ((tmpBuffer[2] & 0xFF) << 16)44 + ((tmpBuffer[3]) << 24);45 }46
47 public synchronized float readFloat() throws IOException {
48 return Float.intBitsToFloat(readInt());Consider adding a doc comment for readShort
31 return (char) ((tmpBuffer[0] & 0xFF) + (tmpBuffer[1] << 8));
32 }
33
34 public synchronized short readShort() throws IOException {35 read(tmpBuffer, 0, 2);3637 return (short) ((tmpBuffer[0] & 0xFF) + (tmpBuffer[1] << 8));38 }39
40 public synchronized int readInt() throws IOException {
41 read(tmpBuffer, 0, 4);Consider adding a doc comment for readChar
25 return (tmpBuffer[0] == 0 ? true : false);
26 }
27
28 public synchronized char readChar() throws IOException {29 read(tmpBuffer, 0, 2);3031 return (char) ((tmpBuffer[0] & 0xFF) + (tmpBuffer[1] << 8));32 }33
34 public synchronized short readShort() throws IOException {
35 read(tmpBuffer, 0, 2);Consider adding a doc comment for readBoolean
20 return tmpBuffer[0];
21 }
22
23 public synchronized boolean readBoolean() throws IOException {24 read(tmpBuffer, 0, 1);25 return (tmpBuffer[0] == 0 ? true : false);26 }27
28 public synchronized char readChar() throws IOException {
29 read(tmpBuffer, 0, 2);Consider adding a doc comment for readDouble
56 + ((tmpBuffer[6] & 0xFFL) << 48) + (((long) tmpBuffer[7]) << 56);
57 }
58
59 public synchronized double readDouble(double val) throws IOException {60 return Double.doubleToLongBits(readLong());61 }62
63}Consider adding a doc comment for readFloat
44 + ((tmpBuffer[3]) << 24);
45 }
46
47 public synchronized float readFloat() throws IOException {48 return Float.intBitsToFloat(readInt());49 }50
51 public synchronized long readLong() throws IOException {
52 read(tmpBuffer, 0, 8);Consider adding a doc comment for readByte
15 super(buf, offset, length);
16 }
17
18 public synchronized byte readByte() throws IOException {19 read(tmpBuffer, 0, 1);20 return tmpBuffer[0];21 }22
23 public synchronized boolean readBoolean() throws IOException {
24 read(tmpBuffer, 0, 1);Consider adding a doc comment for writeObject
42 }
43 }
44
45 public void writeObject(PacketOutputStream aOutputStream)46 throws IOException, IllegalArgumentException, IllegalAccessException {47 List<Class> classes = new ArrayList<>();48 Class current = this.getClass();49 if (current.getSuperclass() != null) {50 classes.add(current.getSuperclass());51 }52 classes.add(current);53 for (Class c : classes) {54 for (Field f : c.getDeclaredFields()) {55 if (f.getType() == byte.class) {56 aOutputStream.putByte((byte) f.get(this));57 } else if (f.getType() == short.class) {58 aOutputStream.putShort((short) f.get(this));59 } else if (f.getType() == int.class) {60 aOutputStream.putInt((int) f.get(this));61 } else if (f.getType().isArray()) {62 if (f.getType().getComponentType() == byte.class) {63 aOutputStream.write((byte[]) f.get(this));64 }65 }66 }67 }68 }69}Consider adding a doc comment for readObject
16 public short index_;
17 public int timestamp_;
18
19 public void readObject(PacketInputStream aInputStream)20 throws IOException, IllegalArgumentException, IllegalAccessException {21 List<Class> classes = new ArrayList<>();22 Class current = this.getClass();23 if (current.getSuperclass() != null) {24 classes.add(current.getSuperclass());25 }26 classes.add(current);27 for (Class c : classes) {28 for (Field f : c.getDeclaredFields()) {29 if (f.getType() == byte.class) {30 f.setByte(this, aInputStream.readByte());31 } else if (f.getType() == short.class) {32 f.setShort(this, aInputStream.readShort());33 } else if (f.getType() == int.class) {34 f.setInt(this, aInputStream.readInt());35 } else if (f.getType().isArray()) {36 if (f.getType().getComponentType() == byte.class) {37 byte[] _arr = (byte[]) f.get(this);38 aInputStream.read(_arr, 0, Array.getLength(_arr));39 }40 }41 }42 }43 }44
45 public void writeObject(PacketOutputStream aOutputStream)
46 throws IOException, IllegalArgumentException, IllegalAccessException {Consider adding a doc comment for main
21 public static byte[] decryptedFileRaw;
22 public static List<MsgHeader> decryptedPackets = new ArrayList<MsgHeader>();
23
24 public static void main(String[] args) { 25 if (args.length < 4) { 26 System.exit(-1); 27 } 28 if (readKeys(args[0]) == false) { 29 System.exit(-2); 30 } 31 if ((sizeEncryptedFile = readData(args[2], true, encryptedPackets)) == 0) { 32 System.exit(-3); 33 } 34 if ((sizeDecryptedFile = readData(args[3], false, decryptedPackets)) == 0) { 35 System.exit(-4); 36 } 37 if (args[1].equals("enc")) { 38 encrypt(); 39 writeData("./encoded.bin", decryptedFileRaw); 40 } 41 if (args[1].equals("dec")) { 42 decrypt(); 43 writeData("./decoded.bin", encryptedFileRaw); 44 } 45 int diff = 0; 46 for (int i = 0; i < sizeEncryptedFile; i++) { 47 diff += (encryptedFileRaw[i] != decryptedFileRaw[i] ? 1 : 0); 48 } 49 50 System.out.printf("%d differences\n", diff); 51 52 System.exit(diff); 53 } 54
55 public static boolean readKeys(String filePath) {
56 try {Consider adding a doc comment for readKeys
52 System.exit(diff);
53 }
54
55 public static boolean readKeys(String filePath) { 56 try { 57 FileInputStream file = new FileInputStream(filePath); 58 file.read(keys); 59 file.close(); 60 } catch (IOException e) { 61 return false; 62 } 63 return true; 64 } 65
66 public static void preparePackets(byte[] buffer, int size, List<MsgHeader> packets) {
67Consider adding a doc comment for preparePackets
63 return true;
64 }
65
66 public static void preparePackets(byte[] buffer, int size, List<MsgHeader> packets) { 67 68 try { 69 PacketInputStream bis = new PacketInputStream(buffer); 70 int i = 0; 71 while (i < size) { 72 bis.mark(i); 73 MsgHeader packet = new MsgHeader(); 74 packet.readObject(bis); 75 if (packet.size_ != 12) { 76 packet = new MsgLockPasswordRequest(); 77 bis.reset(); 78 packet.readObject(bis); 79 } 80 packets.add(packet); 81 i += packet.size_; 82 } 83 } catch (Exception e) { 84 System.out.println(e); 85 } 86 } 87
88 public static void writeData(String filePath, byte[] buffer) {
89 try {Consider adding a doc comment for writeData
85 }
86 }
87
88 public static void writeData(String filePath, byte[] buffer) { 89 try { 90 File file = new File(filePath); 91 FileOutputStream fileStream = new FileOutputStream(file); 92 fileStream.write(buffer); 93 fileStream.close(); 94 } catch (Exception e) { 95 } 96 } 97
98 public static long readData(String filePath, boolean encrypted, List<MsgHeader> packets) {
99 int size = 0;Consider adding a doc comment for readData
95 }
96 }
97
98 public static long readData(String filePath, boolean encrypted, List<MsgHeader> packets) { 99 int size = 0;100 try {101 File file = new File(filePath);102 FileInputStream fileStream = new FileInputStream(file);103 size = (int) file.length();104 if (encrypted) {105 encryptedFileRaw = new byte[size];106 fileStream.read(encryptedFileRaw);107 fileStream.close();108 preparePackets(encryptedFileRaw, size, packets);109 } else {110 decryptedFileRaw = new byte[size];111 fileStream.read(decryptedFileRaw);112 fileStream.close();113 preparePackets(decryptedFileRaw, size, packets);114 }115 } catch (Exception e) {116 System.out.println(e);117 }118 return (long) size;119 }120
121 public static void decrypt() {
122 int offset = 0;Consider adding a doc comment for decrypt
118 return (long) size;
119 }
120
121 public static void decrypt() {122 int offset = 0;123 for (MsgHeader packet : encryptedPackets) {124 try {125 PacketOutputStream pos = new PacketOutputStream();126 packet.writeObject(pos);127 byte[] buffer = pos.toByteArray();128 pos.flush();129 int key = (int) (keys[(int) (packet.key_ & 0xFF) << 1] & 0xFF);130 short j = 4;131 do {132 int mappedKey = (int) (keys[((key % 256) << 1) + 1] & 0xFF);133 switch (j & 3) {134 case 0:135 buffer[j] = (byte) (buffer[j] - (byte) (mappedKey << 1));136 break;137 case 1:138 buffer[j] = (byte) (buffer[j] + (byte) ((int) (mappedKey >>> 3)));139 break;140 case 2:141 buffer[j] = (byte) (buffer[j] - (byte) (mappedKey << 2));142 break;143 case 3:144 buffer[j] = (byte) (buffer[j] + (byte) ((int) (mappedKey >>> 5)));145 break;146 }147 encryptedFileRaw[offset + j] = buffer[j];148 j++;149 key++;150 } while (j < packet.size_);151 offset += j;152 } catch (Exception e) {153 }154 }155 }156
157 public static void encrypt() {
158 int offset = 0;Consider adding a doc comment for encrypt
154 }
155 }
156
157 public static void encrypt() {158 int offset = 0;159 for (MsgHeader packet : decryptedPackets) {160 try {161 PacketOutputStream pos = new PacketOutputStream();162 packet.writeObject(pos);163 byte[] buffer = pos.toByteArray();164 pos.flush();165 int key = (byte) keys[packet.key_ << 1];166 short j = 4;167 do {168 int mappedKey = keys[((key % 256) << 1) + 1];169 switch (j & 3) {170 case 0:171 buffer[j] = (byte) (buffer[j] + (byte) (mappedKey << 1));172 break;173 case 1:174 buffer[j] = (byte) (buffer[j] - (byte) ((int) (mappedKey >>> 3)));175 break;176 case 2:177 buffer[j] = (byte) (buffer[j] + (byte) (mappedKey << 2));178 break;179 case 3:180 buffer[j] = (byte) (buffer[j] - (byte) ((int) (mappedKey >>> 5)));181 break;182 }183 decryptedFileRaw[offset + j] = buffer[j];184 j++;185 key++;186 } while (j < packet.size_);187 offset += j;188 } catch (Exception e) {189 }190 }191 }192}
Description
This method does not have any documentation.
Consider adding a documentation comment to explain its use.
While it may seem like the usage of a method is perfectly obvious, any consumers of your API may not be able to pick up on certain details.
Bad Practice
This method appears to return an address string based on its name and the return type, but it is hard to say anything further about it. We neither know if the address will be formatted in a special way nor are we given any useful information regarding the returned value.
String getAddress() {
// ...
}
Recommended
Provide a detailed description of what the method does.
/**
* Returns the address in 3 line format,
* with street address on line 1, area/city on line 2
* and state and country as well as postal code on line 3.
*/
String getAddress() {
// ...
}