public class Yaml extends Object
Modifier and Type | Class and Description |
---|---|
static class |
Yaml.CustomConstructor
Defines constructor logic for custom types in this library.
|
static class |
Yaml.CustomRepresenter |
Constructor and Description |
---|
Yaml() |
Modifier and Type | Method and Description |
---|---|
static void |
addModelMap(String apiGroupVersion,
String kind,
Class<?> clazz)
Deprecated.
|
static String |
dump(Object object)
Takes an API object and returns a YAML String representing that object.
|
static void |
dump(Object object,
Writer writer)
Takes an API object and writes a YAML string representing that object to the writer.
|
static String |
dumpAll(Iterator<? extends io.kubernetes.client.common.KubernetesType> data)
Takes an Iterator of YAML API objects and returns a YAML string representing all of them
|
static void |
dumpAll(Iterator<? extends io.kubernetes.client.common.KubernetesType> data,
Writer output)
Takes an Iterator of YAML API objects and writes a YAML String representing all of them.
|
static org.yaml.snakeyaml.Yaml |
getSnakeYaml()
Deprecated.
|
static org.yaml.snakeyaml.Yaml |
getSnakeYaml(Class<?> type,
org.yaml.snakeyaml.DumperOptions dumperOptions,
org.yaml.snakeyaml.LoaderOptions loaderOptions,
org.yaml.snakeyaml.TypeDescription... typeDescriptions)
Instantiate a snake yaml with the target model type, and the dump/load option specified..
|
static org.yaml.snakeyaml.Yaml |
getSnakeYaml(Class<?> type,
org.yaml.snakeyaml.TypeDescription... typeDescriptions)
Instantiate a snake yaml with the target model type specified..
|
static Object |
load(File f)
Load an API object from a YAML file.
|
static Object |
load(Reader reader)
Load an API object from a stream of data.
|
static Object |
load(String content)
Load an API object from a YAML string representation.
|
static List<Object> |
loadAll(File f)
Load list of instantiated API objects from a YAML file.
|
static List<Object> |
loadAll(Reader reader)
Load list of instantiated API objects from a stream of data.
|
static List<Object> |
loadAll(String content)
Load list of instantiated API objects from a YAML string representation.
|
static <T> T |
loadAs(File f,
Class<T> clazz)
Load an API object from a YAML file.
|
static <T> T |
loadAs(Reader reader,
Class<T> clazz)
Load an API object from a YAML stream.
|
static <T> T |
loadAs(String content,
Class<T> clazz)
Load an API object from a YAML string representation.
|
static org.yaml.snakeyaml.TypeDescription |
newGsonCompatibleTypeDescription(Class modelClass,
String... gsonTaggedFields)
Instantiate a new
TypeDescription which will load the SerializedName via
reflection so that yaml serialization can work for the custom gson serialized name. |
public static Object load(String content) throws IOException
content
- The YAML contentIOException
- If an error occurs while reading the YAML.public static Object load(File f) throws IOException
f
- The file to load.IOException
- If an error occurs while reading the YAML.public static Object load(Reader reader) throws IOException
reader
- The stream to load.IOException
- If an error occurs while reading the YAML.public static <T> T loadAs(String content, Class<T> clazz)
content
- The YAML contentclazz
- The class of object to return.IOException
- If an error occurs while reading the YAML.public static <T> T loadAs(File f, Class<T> clazz) throws IOException
f
- The YAML fileclazz
- The class of object to return.IOException
- If an error occurs while reading the YAML.public static <T> T loadAs(Reader reader, Class<T> clazz)
reader
- The YAML streamclazz
- The class of object to return.IOException
- If an error occurs while reading the YAML.public static List<Object> loadAll(String content) throws IOException
Order of API objects in list will be preserved according to order of objects in YAML string.
content
- The YAML contentIOException
- If an error occurs while reading the YAML.public static List<Object> loadAll(File f) throws IOException
Order of API objects in list will be preserved according to order of objects in YAML file.
f
- The file to load.IOException
- If an error occurs while reading the YAML.public static List<Object> loadAll(Reader reader) throws IOException
Order of API objects in list will be preserved according to order of objects in stream of data.
reader
- The stream to load.IOException
- If an error occurs while reading the YAML.public static String dump(Object object)
object
- The API object to dump.public static void dump(Object object, Writer writer)
object
- The API object to dumpwriter
- The writer to write the YAML to.public static String dumpAll(Iterator<? extends io.kubernetes.client.common.KubernetesType> data)
data
- The list of YAML API objectspublic static void dumpAll(Iterator<? extends io.kubernetes.client.common.KubernetesType> data, Writer output)
data
- The list of YAML API objects.output
- The writer to output the YAML String to.@Deprecated public static org.yaml.snakeyaml.Yaml getSnakeYaml()
SafeConstructor
.
DEPRECATED: Use the parameterized "getSnakeYaml" constructing method below to get rid of vulnerability from dynamic type serialization.
public static org.yaml.snakeyaml.Yaml getSnakeYaml(Class<?> type, org.yaml.snakeyaml.TypeDescription... typeDescriptions)
type
- the target model typetypeDescriptions
- additional type descriptions for customizing the serializerpublic static org.yaml.snakeyaml.Yaml getSnakeYaml(Class<?> type, org.yaml.snakeyaml.DumperOptions dumperOptions, org.yaml.snakeyaml.LoaderOptions loaderOptions, org.yaml.snakeyaml.TypeDescription... typeDescriptions)
type
- the target model typedumperOptions
- the dumper optionsloaderOptions
- the loader optionstypeDescriptions
- additional type descriptions for customizing the serializerpublic static org.yaml.snakeyaml.TypeDescription newGsonCompatibleTypeDescription(Class modelClass, String... gsonTaggedFields)
TypeDescription
which will load the SerializedName
via
reflection so that yaml serialization can work for the custom gson serialized name.modelClass
- the kubenretes api model classgsonTaggedFields
- the custom serialized names tagged by gson@Deprecated public static void addModelMap(String apiGroupVersion, String kind, Class<?> clazz)
Copyright © 2022. All rights reserved.