Module json.extensions.main
Package io.github.astrapi69.yaml

Class YamlFileToObjectExtensions

java.lang.Object
io.github.astrapi69.yaml.YamlFileToObjectExtensions
public final class YamlFileToObjectExtensions extends Object
The class YamlFileToObjectExtensions converts yaml strings to java object and java collections.

  • Method Summary

    Modifier and Type
    Method
    Description
    static <K, V> Map<K,V>
    toMapObject(File yamlFile, com.fasterxml.jackson.core.type.TypeReference<Map<K,V>> typeReference)
    Transforms the given yaml file into a java map object
    static <K, V> Map<K,V>
    toMapObject(File yamlFile, com.fasterxml.jackson.core.type.TypeReference<Map<K,V>> typeReference, com.fasterxml.jackson.databind.ObjectMapper mapper)
    Transforms the given yaml file into a java map object
    static <T> T
    toObject(File yamlFile, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, com.fasterxml.jackson.databind.ObjectMapper mapper)
    Transforms the given yaml file into a java object.
    static <T> T
    toObject(File yamlFile, Class<T> clazz)
    Transforms the given yaml file into a java object.
    static <T> T
    toObject(File yamlFile, Class<T> clazz, com.fasterxml.jackson.databind.ObjectMapper mapper)
    Transforms the given yaml file into a java object.
    static <T> Collection<T>
    toObjectCollection(File yamlFile, Class<? extends Collection> collectionClass, Class<T> elementClass)
    Transforms the given yaml file into a java object Collection
    static <T> List<T>
    toObjectList(File yamlFile, Class<T> elementClass)
    Transforms the given yaml string into a java object List

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • toMapObject

      public static <K, V> Map<K,V> toMapObject(File yamlFile, com.fasterxml.jackson.core.type.TypeReference<Map<K,V>> typeReference) throws IOException
      Transforms the given yaml file into a java map object
      Type Parameters:
      K - the generic type of keys
      V - the generic type of values
      Parameters:
      yamlFile - the yaml file
      typeReference - the type reference
      Returns:
      the t
      Throws:
      IOException - Signals that an I/O exception has occurred

    • toMapObject

      public static <K, V> Map<K,V> toMapObject(File yamlFile, com.fasterxml.jackson.core.type.TypeReference<Map<K,V>> typeReference, com.fasterxml.jackson.databind.ObjectMapper mapper) throws IOException
      Transforms the given yaml file into a java map object
      Type Parameters:
      K - the generic type of keys
      V - the generic type of values
      Parameters:
      yamlFile - the yaml file
      typeReference - the type reference
      mapper - the object mapper
      Returns:
      the t
      Throws:
      IOException - Signals that an I/O exception has occurred

    • toObject

      public static <T> T toObject(File yamlFile, Class<T> clazz) throws IOException
      Transforms the given yaml file into a java object.
      Type Parameters:
      T - the generic type
      Parameters:
      yamlFile - the yaml file
      clazz - the clazz
      Returns:
      the t
      Throws:
      IOException - Signals that an I/O exception has occurred

    • toObject

      public static <T> T toObject(File yamlFile, Class<T> clazz, com.fasterxml.jackson.databind.ObjectMapper mapper) throws IOException
      Transforms the given yaml file into a java object.
      Type Parameters:
      T - the generic type
      Parameters:
      yamlFile - the yaml file
      clazz - the clazz
      mapper - the mapper
      Returns:
      the t
      Throws:
      IOException - Signals that an I/O exception has occurred

    • toObject

      public static <T> T toObject(File yamlFile, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, com.fasterxml.jackson.databind.ObjectMapper mapper) throws IOException
      Transforms the given yaml file into a java object.
      Type Parameters:
      T - the generic type
      Parameters:
      yamlFile - the yaml file
      typeReference - the type reference
      mapper - the mapper
      Returns:
      the t
      Throws:
      IOException - Signals that an I/O exception has occurred

    • toObjectCollection

      public static <T> Collection<T> toObjectCollection(File yamlFile, Class<? extends Collection> collectionClass, Class<T> elementClass) throws IOException
      Transforms the given yaml file into a java object Collection
      Type Parameters:
      T - the generic type of the return type
      Parameters:
      yamlFile - the yaml file
      collectionClass - the collection class
      elementClass - the element class
      Returns:
      the list with the java objects.
      Throws:
      IOException - Signals that an I/O exception has occurred

    • toObjectList

      public static <T> List<T> toObjectList(File yamlFile, Class<T> elementClass) throws IOException
      Transforms the given yaml string into a java object List
      Type Parameters:
      T - the generic type of the return type
      Parameters:
      yamlFile - the yaml file
      elementClass - the element class of the generic type
      Returns:
      the list with the java objects
      Throws:
      IOException - Signals that an I/O exception has occurred.