How Java uses APIs from Jackson, SnapeYAML, or YamlBeans libraries to write data to YAML files
To use the APIs of Jackson, SnapeYAML, or YamlBeans libraries to write data to YAML files, you need to add relevant maven dependencies.
1. Use Jackson library:
In the pom.xml file, add the following dependencies:
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-yaml</artifactId>
<version>2.12.3</version>
</dependency>
Sample YAML file:
yaml
person:
name: John Doe
age: 30
email: johndoe@example.com
Java sample code:
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
public class WriteYamlUsingJackson {
public static void main(String[] args) {
try {
ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory());
File file = new File("example.yaml");
Map<String, Object> data = new HashMap<>();
data.put("person", new Person("John Doe", 30, "johndoe@example.com"));
objectMapper.writeValue(file, data);
} catch (IOException ex) {
ex.printStackTrace();
}
}
}
class Person {
private String name;
private int age;
private String email;
// Constructors, getters, and setters
public Person(String name, int age, String email) {
this.name = name;
this.age = age;
this.email = email;
}
}
2. Use the SnapeYAML library:
In the pom.xml file, add the following dependencies:
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
<version>1.29</version>
</dependency>
The sample YAML file is the same as above.
Java sample code:
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;
import java.io.FileWriter;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
public class WriteYamlUsingSnakeYAML {
public static void main(String[] args) {
DumperOptions options = new DumperOptions();
options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
Yaml yaml = new Yaml(options);
try (FileWriter writer = new FileWriter("example.yaml")) {
Map<String, Object> data = new HashMap<>();
data.put("person", new Person("John Doe", 30, "johndoe@example.com"));
yaml.dump(data, writer);
} catch (IOException ex) {
ex.printStackTrace();
}
}
}
class Person {
private String name;
private int age;
private String email;
// Constructors, getters, and setters
public Person(String name, int age, String email) {
this.name = name;
this.age = age;
this.email = email;
}
}
3. Use the YamlBeans library:
In the pom.xml file, add the following dependencies:
<dependency>
<groupId>com.esotericsoftware</groupId>
<artifactId>yamlbeans</artifactId>
<version>1.14</version>
</dependency>
The sample YAML file is the same as above.
Java sample code:
import com.esotericsoftware.yamlbeans.YamlWriter;
import java.io.FileWriter;
import java.io.IOException;
public class WriteYamlUsingYamlBeans {
public static void main(String[] args) {
try (YamlWriter writer = new YamlWriter(new FileWriter("example.yaml"))) {
writer.getConfig().setClassTag("person", Person.class);
writer.write(new Person("John Doe", 30, "johndoe@example.com"));
} catch (IOException ex) {
ex.printStackTrace();
}
}
}
class Person {
private String name;
private int age;
private String email;
// Constructors, getters, and setters
public Person(String name, int age, String email) {
this.name = name;
this.age = age;
this.email = email;
}
}
The above example uses APIs from Jackson, SnapeYAML, and YamlBeans libraries to write data to a YAML file containing personal information, respectively. Pay attention to replacing the file path and file name to meet your actual needs.
