Skip to content

Commit 84546e2

Browse files
authored
Merge pull request #591 from CycloneDX/Polish_code
2 parents 69ebbf9 + 3781b64 commit 84546e2

File tree

7 files changed

+30
-50
lines changed

7 files changed

+30
-50
lines changed

src/main/java/org/cyclonedx/model/component/crypto/AlgorithmProperties.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@
2929
"mode",
3030
"padding",
3131
"cryptoFunctions",
32-
"classicalSecurityLevel", "nistQuantumSecurityLevel"
32+
"classicalSecurityLevel",
33+
"nistQuantumSecurityLevel"
3334
})
3435
public class AlgorithmProperties
3536
{

src/main/java/org/cyclonedx/util/serializer/EnvironmentVarsSerializer.java

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,7 @@ private void serializeXml(List<Object> choices, ToXmlGenerator xmlGenerator) thr
4848
xmlGenerator.writeStartObject();
4949
for (Object choice : choices) {
5050
if (choice instanceof Property) {
51-
xmlGenerator.writeFieldName("environmentVar");
52-
xmlGenerator.writeStartObject();
53-
Property prop = (Property) choice;
54-
xmlGenerator.setNextIsAttribute(true);
55-
xmlGenerator.writeFieldName("name");
56-
xmlGenerator.writeString(prop.getName());
57-
xmlGenerator.setNextIsAttribute(false);
58-
59-
xmlGenerator.setNextIsUnwrapped(true);
60-
xmlGenerator.writeStringField("", prop.getValue());
61-
xmlGenerator.writeEndObject();
51+
SerializerUtils.serializeProperty("environmentVar", (Property) choice, xmlGenerator);
6252
} else if (choice instanceof String) {
6353
xmlGenerator.writeFieldName("value");
6454
xmlGenerator.writeString((String) choice);

src/main/java/org/cyclonedx/util/serializer/InputTypeSerializer.java

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,20 +54,13 @@ else if (input.getData() != null) {
5454
jsonGenerator.writeObject(input.getData());
5555
}
5656

57-
writeField(jsonGenerator, "source", input.getSource());
58-
writeField(jsonGenerator, "target", input.getTarget());
59-
writeField(jsonGenerator, "properties", input.getProperties());
57+
SerializerUtils.writeField(jsonGenerator, "source", input.getSource());
58+
SerializerUtils.writeField(jsonGenerator, "target", input.getTarget());
59+
SerializerUtils.writeField(jsonGenerator, "properties", input.getProperties());
6060

6161
jsonGenerator.writeEndObject();
6262
}
6363

64-
protected void writeField(JsonGenerator jsonGenerator, String fieldName, Object fieldValue) throws IOException {
65-
if (fieldValue != null) {
66-
jsonGenerator.writeFieldName(fieldName);
67-
jsonGenerator.writeObject(fieldValue);
68-
}
69-
}
70-
7164
@Override
7265
public Class<InputType> handledType() {
7366
return InputType.class;

src/main/java/org/cyclonedx/util/serializer/OutputTypeSerializer.java

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ else if (output.getData() != null) {
5050
jsonGenerator.writeObject( output.getData());
5151
}
5252

53-
writeField(jsonGenerator, "type", output.getType());
54-
writeField(jsonGenerator, "source", output.getSource());
55-
writeField(jsonGenerator, "target", output.getTarget());
56-
writeField(jsonGenerator, "properties", output.getProperties());
53+
SerializerUtils.writeField(jsonGenerator, "type", output.getType());
54+
SerializerUtils.writeField(jsonGenerator, "source", output.getSource());
55+
SerializerUtils.writeField(jsonGenerator, "target", output.getTarget());
56+
SerializerUtils.writeField(jsonGenerator, "properties", output.getProperties());
5757
jsonGenerator.writeEndObject();
5858
}
5959

@@ -93,13 +93,6 @@ else if (output.getData() != null) {
9393
xmlGenerator.writeEndObject();
9494
}
9595

96-
protected void writeField(JsonGenerator jsonGenerator, String fieldName, Object fieldValue) throws IOException {
97-
if (fieldValue != null) {
98-
jsonGenerator.writeFieldName(fieldName);
99-
jsonGenerator.writeObject(fieldValue);
100-
}
101-
}
102-
10396
@Override
10497
public Class<OutputType> handledType() {
10598
return OutputType.class;

src/main/java/org/cyclonedx/util/serializer/PropertiesSerializer.java

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,7 @@ private static void serializeXml(final List<Property> properties, final ToXmlGen
5555
{
5656
xmlGenerator.writeStartArray();
5757
for (Property property : properties) {
58-
xmlGenerator.writeStartObject("property");
59-
xmlGenerator.setNextIsAttribute(true);
60-
xmlGenerator.writeFieldName("name");
61-
xmlGenerator.writeString(property.getName());
62-
xmlGenerator.setNextIsAttribute(false);
63-
64-
xmlGenerator.setNextIsUnwrapped(true);
65-
xmlGenerator.writeStringField("", property.getValue());
66-
xmlGenerator.writeEndObject();
58+
SerializerUtils.serializeProperty("property", property, xmlGenerator);
6759
}
6860
xmlGenerator.writeEndArray();
6961
}

src/main/java/org/cyclonedx/util/serializer/SerializerUtils.java

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
import com.fasterxml.jackson.dataformat.xml.ser.ToXmlGenerator;
88
import org.cyclonedx.Version;
99
import org.cyclonedx.model.Hash;
10+
import org.cyclonedx.model.Property;
1011
import org.cyclonedx.model.VersionFilter;
1112

1213
public class SerializerUtils
@@ -42,5 +43,23 @@ public static boolean shouldSerializeField(Object obj, Version version, String f
4243
}
4344
}
4445

46+
public static void serializeProperty(String propertyName, Property prop, ToXmlGenerator xmlGenerator) throws IOException {
47+
xmlGenerator.writeFieldName(propertyName);
48+
xmlGenerator.writeStartObject();
49+
xmlGenerator.setNextIsAttribute(true);
50+
xmlGenerator.writeFieldName("name");
51+
xmlGenerator.writeString(prop.getName());
52+
xmlGenerator.setNextIsAttribute(false);
4553

54+
xmlGenerator.setNextIsUnwrapped(true);
55+
xmlGenerator.writeStringField("", prop.getValue());
56+
xmlGenerator.writeEndObject();
57+
}
58+
59+
public static void writeField(JsonGenerator jsonGenerator, String fieldName, Object fieldValue) throws IOException {
60+
if (fieldValue != null) {
61+
jsonGenerator.writeFieldName(fieldName);
62+
jsonGenerator.writeObject(fieldValue);
63+
}
64+
}
4665
}

src/test/java/org/cyclonedx/BomJsonGeneratorTest.java

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,8 @@
2020

2121
import com.fasterxml.jackson.databind.JsonNode;
2222

23-
import java.io.FileReader;
2423
import java.nio.charset.StandardCharsets;
2524
import org.apache.commons.io.IOUtils;
26-
import org.cyclonedx.exception.GeneratorException;
2725
import org.cyclonedx.generators.BomGeneratorFactory;
2826
import org.cyclonedx.generators.json.BomJsonGenerator;
2927
import org.cyclonedx.generators.xml.BomXmlGenerator;
@@ -33,10 +31,8 @@
3331
import org.cyclonedx.model.License;
3432
import org.cyclonedx.model.LicenseChoice;
3533
import org.cyclonedx.model.Metadata;
36-
import org.cyclonedx.model.OrganizationalContact;
3734
import org.cyclonedx.model.Service;
3835
import org.cyclonedx.model.license.Expression;
39-
import org.cyclonedx.model.metadata.ToolInformation;
4036
import org.cyclonedx.parsers.JsonParser;
4137
import org.cyclonedx.parsers.XmlParser;
4238
import org.junit.jupiter.api.AfterEach;
@@ -52,10 +48,6 @@
5248
import java.nio.file.Files;
5349
import java.nio.file.Path;
5450
import java.util.ArrayList;
55-
import java.util.Arrays;
56-
import java.util.LinkedList;
57-
import java.util.List;
58-
import java.util.UUID;
5951
import java.util.stream.Stream;
6052
import java.util.Objects;
6153

0 commit comments

Comments
 (0)