iSharkFly-Docs/java-tutorials
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

BAEL-1979 Added examples for SnakeYAML Library

Browse Source
This commit is contained in:
Sandip Singh
2018-07-24 11:23:39 +05:30
parent 896a2d071a
commit e55944b8c1
13 changed files with 392 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pom.xml
+3
View File
@@ -550,6 +550,7 @@
<module>spring-reactive-kotlin</module>
<module>jnosql</module>
<module>testing-modules/junit-abstract</module>
<module>snakeyaml</module>
</modules>
</profile>
@@ -670,6 +671,7 @@
<module>spring-apache-camel</module>
<module>spring-batch</module>
<module>testing-modules/junit-abstract</module>
<module>snakeyaml</module>
<!-- group 2 - Pass, 11-16 min, 42 test failures, 4,020 KB -->
@@ -1076,6 +1078,7 @@
<module>maven-archetype</module>
<module>apache-meecrowave</module>
<module>testing-modules/junit-abstract</module>
<module>snakeyaml</module>
<!-- problematic -->
<!--
snakeyaml/pom.xml
+29
View File
@@ -0,0 +1,29 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>snakeyaml</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>snakeyaml</name>
<url>http://maven.apache.org</url>
<parent>
<groupId>com.baeldung</groupId>
<artifactId>parent-modules</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
<version>1.21</version>
</dependency>
</dependencies>
</project>
snakeyaml/src/main/java/com/baeldung/snakeyaml/model/Address.java
+41
View File
@@ -0,0 +1,41 @@
package com.baeldung.snakeyaml.model;
public class Address {
private String line;
private String city;
private String state;
private Integer zip;
public String getLine() {
return line;
}
public void setLine(String line) {
this.line = line;
}
public String getCity() {
return city;
}
public void setCity(String city) {
this.city = city;
}
public String getState() {
return state;
}
public void setState(String state) {
this.state = state;
}
public Integer getZip() {
return zip;
}
public void setZip(Integer zip) {
this.zip = zip;
}
}
snakeyaml/src/main/java/com/baeldung/snakeyaml/model/Contact.java
+25
View File
@@ -0,0 +1,25 @@
package com.baeldung.snakeyaml.model;
public class Contact {
private String type;
private Integer number;
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
public Integer getNumber() {
return number;
}
public void setNumber(Integer number) {
this.number = number;
}
}
snakeyaml/src/main/java/com/baeldung/snakeyaml/model/Customer.java
+62
View File
@@ -0,0 +1,62 @@
package com.baeldung.snakeyaml.model;
import java.util.List;
public class Customer {
private String firstName;
private String lastName;
private Integer age;
private List<Contact> contactDetails;
private Address homeAddress;
private Address officeAddress;
public String getFirstName() {
return firstName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public List<Contact> getContactDetails() {
return contactDetails;
}
public void setContactDetails(List<Contact> contactDetails) {
this.contactDetails = contactDetails;
}
public Address getHomeAddress() {
return homeAddress;
}
public void setHomeAddress(Address homeAddress) {
this.homeAddress = homeAddress;
}
public Address getOfficeAddress() {
return officeAddress;
}
public void setOfficeAddress(Address officeAddress) {
this.officeAddress = officeAddress;
}
}
snakeyaml/src/test/java/com/baeldung/snakeyaml/JavaToYAMLSerializationUnitTest.java
+51
View File
@@ -0,0 +1,51 @@
package com.baeldung.snakeyaml;
import java.io.StringWriter;
import java.util.LinkedHashMap;
import java.util.Map;
import org.junit.Test;
import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.nodes.Tag;
import com.baeldung.snakeyaml.model.Customer;
public class JavaToYAMLSerializationUnitTest {
@Test
public void whenDumpMap_thenGenerateCorrectYAML() {
Map<String, Object> data = new LinkedHashMap<String, Object>();
data.put("name", "Silenthand Olleander");
data.put("race", "Human");
data.put("traits", new String[] { "ONE_HAND", "ONE_EYE" });
Yaml yaml = new Yaml();
StringWriter writer = new StringWriter();
yaml.dump(data, writer);
System.out.println(writer.toString());
}
@Test
public void whenDumpACustomType_thenGenerateCorrectYAML() {
Customer customer = new Customer();
customer.setAge(45);
customer.setFirstName("Greg");
customer.setLastName("McDowell");
Yaml yaml = new Yaml();
StringWriter writer = new StringWriter();
yaml.dump(customer, writer);
System.out.println(writer.toString());
}
@Test
public void whenDumpAsCustomType_thenGenerateCorrectYAML() {
Customer customer = new Customer();
customer.setAge(45);
customer.setFirstName("Greg");
customer.setLastName("McDowell");
Yaml yaml = new Yaml();
yaml.dumpAs(customer, Tag.MAP, null);
System.out.println(yaml.dumpAs(customer, Tag.MAP, null));
}
}
snakeyaml/src/test/java/com/baeldung/snakeyaml/YAMLToJavaDeserialisationUnitTest.java
+135
View File
@@ -0,0 +1,135 @@
package com.baeldung.snakeyaml;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import java.io.InputStream;
import java.util.Date;
import java.util.Map;
import org.junit.Test;
import org.yaml.snakeyaml.TypeDescription;
import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.constructor.Constructor;
import com.baeldung.snakeyaml.model.Contact;
import com.baeldung.snakeyaml.model.Customer;
public class YAMLToJavaDeserialisationUnitTest {
@Test
public void whenLoadYAMLDocument_thenLoadCorrectMap() {
Yaml yaml = new Yaml();
InputStream inputStream = this.getClass()
.getClassLoader()
.getResourceAsStream("customer.yaml");
Map<String, Object> obj = yaml.load(inputStream);
System.out.println(obj);
}
@Test
public void whenLoadYAMLDocumentWithTopLevelClass_thenLoadCorrectJavaObject() {
Yaml yaml = new Yaml(new Constructor(Customer.class));
InputStream inputStream = this.getClass()
.getClassLoader()
.getResourceAsStream("customer.yaml");
Customer customer = yaml.load(inputStream);
System.out.println(customer);
}
@Test
public void whenLoadYAMLDocumentWithAssumedClass_thenLoadCorrectJavaObject() {
Yaml yaml = new Yaml();
InputStream inputStream = this.getClass()
.getClassLoader()
.getResourceAsStream("customer_with_type.yaml");
Customer customer = yaml.load(inputStream);
System.out.println(customer);
}
@Test
public void whenLoadYAML_thenLoadCorrectImplicitTypes() {
Yaml yaml = new Yaml();
Map<Object, Object> document = yaml.load("3.0: 2018-07-22");
assertNotNull(document);
assertTrue(document.size() == 1);
assertTrue(document.containsKey(Double.valueOf(3.0)));
assertTrue(document.get(Double.valueOf(3.0)) instanceof Date);
}
@Test
public void whenLoadYAMLDocumentWithTopLevelClass_thenLoadCorrectJavaObjectWithNestedObjects() {
Yaml yaml = new Yaml(new Constructor(Customer.class));
InputStream inputStream = this.getClass()
.getClassLoader()
.getResourceAsStream("customer_with_contact_details_and_address.yaml");
Customer customer = yaml.load(inputStream);
assertNotNull(customer);
assertEquals("John", customer.getFirstName());
assertEquals("Doe", customer.getLastName());
assertTrue(customer.getAge() == 31);
assertNotNull(customer.getContactDetails());
assertTrue(customer.getContactDetails()
.size() == 2);
assertEquals("mobile", customer.getContactDetails()
.get(0)
.getType());
assertTrue(customer.getContactDetails()
.get(0)
.getNumber() == 123456789);
assertEquals("landline", customer.getContactDetails()
.get(1)
.getType());
assertTrue(customer.getContactDetails()
.get(1)
.getNumber() == 456786868);
assertNotNull(customer.getHomeAddress());
assertEquals("Xyz, DEF Street", customer.getHomeAddress()
.getLine());
assertNotNull(customer.getHomeAddress());
assertEquals("Xyz, Office Street", customer.getOfficeAddress()
.getLine());
}
@Test
public void whenLoadYAMLDocumentWithTypeDescription_thenLoadCorrectJavaObjectWithCorrectGenericType() {
Constructor constructor = new Constructor(Customer.class);
TypeDescription customTypeDescription = new TypeDescription(Customer.class);
customTypeDescription.addPropertyParameters("contactDetails", Contact.class);
constructor.addTypeDescription(customTypeDescription);
Yaml yaml = new Yaml(constructor);
InputStream inputStream = this.getClass()
.getClassLoader()
.getResourceAsStream("customer_with_contact_details.yaml");
Customer customer = yaml.load(inputStream);
assertNotNull(customer);
assertEquals("John", customer.getFirstName());
assertEquals("Doe", customer.getLastName());
assertTrue(customer.getAge() == 31);
assertNotNull(customer.getContactDetails());
assertTrue(customer.getContactDetails()
.size() == 2);
assertEquals("mobile", customer.getContactDetails()
.get(0)
.getType());
assertEquals("landline", customer.getContactDetails()
.get(1)
.getType());
}
@Test
public void whenLoadMultipleYAMLDocuments_thenLoadCorrectJavaObjects() {
Yaml yaml = new Yaml(new Constructor(Customer.class));
InputStream inputStream = this.getClass()
.getClassLoader()
.getResourceAsStream("customers.yaml");
int count = 0;
for (Object object : yaml.loadAll(inputStream)) {
count++;
assertTrue(object instanceof Customer);
}
assertTrue(count == 2);
}
}
snakeyaml/src/test/resources/customer.yaml
+3
View File
@@ -0,0 +1,3 @@
firstName: "John"
lastName: "Doe"
age: 20
snakeyaml/src/test/resources/customer_with_contact_details.yaml
+7
View File
@@ -0,0 +1,7 @@
firstName: "John"
lastName: "Doe"
age: 31
contactDetails:
- { type: "mobile", number: 123456789}
- { type: "landline", number: 456786868}
snakeyaml/src/test/resources/customer_with_contact_details_and_address.yaml
+18
View File
@@ -0,0 +1,18 @@
firstName: "John"
lastName: "Doe"
age: 31
contactDetails:
- type: "mobile"
number: 123456789
- type: "landline"
number: 456786868
homeAddress:
line: "Xyz, DEF Street"
city: "City Y"
state: "State Y"
zip: 345657
officeAddress:
line: "Xyz, Office Street"
city: "City Y"
state: "State Y"
zip: 345657
snakeyaml/src/test/resources/customer_with_contact_details_and_tags.yaml
+6
View File
@@ -0,0 +1,6 @@
firstName: "John"
lastName: "Doe"
age: 31
contactDetails:
- !contact { type: "mobile", number: 123456789}
- !contact { type: "landline", number: 456786868}
snakeyaml/src/test/resources/customer_with_type.yaml
+4
View File
@@ -0,0 +1,4 @@
!!com.baeldung.snakeyaml.model.Customer
firstName: "John"
lastName: "Doe"
age: 20
snakeyaml/src/test/resources/customers.yaml
+8
View File
@@ -0,0 +1,8 @@
---
firstName: "John"
lastName: "Doe"
age: 20
---
firstName: "Jack"
lastName: "Jones"
age: 25