Package org.openrewrite.config

Class YamlResourceLoader

java.lang.Object

org.openrewrite.config.YamlResourceLoader

All Implemented Interfaces:

ResourceLoader

public class YamlResourceLoader
extends Object
implements ResourceLoader

Constructor Summary

Constructors

Constructor	Description
YamlResourceLoader(InputStream yamlInput, URI source, Properties properties)	Load a declarative recipe using the runtime classloader
YamlResourceLoader(InputStream yamlInput, URI source, Properties properties, @Nullable ClassLoader classLoader)	Load a declarative recipe, optionally using the specified classloader
YamlResourceLoader(InputStream yamlInput, URI source, Properties properties, @Nullable ClassLoader classLoader, Collection<? extends ResourceLoader> dependencyResourceLoaders)	Load a declarative recipe, optionally using the specified classloader and optionally including resource loaders for recipes from dependencies.
YamlResourceLoader(InputStream yamlInput, URI source, Properties properties, @Nullable ClassLoader classLoader, Collection<? extends ResourceLoader> dependencyResourceLoaders, Consumer<com.fasterxml.jackson.databind.ObjectMapper> mapperCustomizer)	Load a declarative recipe, optionally using the specified classloader and optionally including resource loaders for recipes from dependencies.

Method Summary

Modifier and Type	Method	Description
Collection<CategoryDescriptor>	listCategoryDescriptors()
Map<String,List<Contributor>>	listContributors()
Collection<RecipeDescriptor>	listRecipeDescriptors()
Collection<RecipeDescriptor>	listRecipeDescriptors(Collection<Recipe> externalRecipes, Map<String,List<Contributor>> recipeNamesToContributors, Map<String,List<RecipeExample>> recipeNamesToExamples)
Map<String,List<RecipeExample>>	listRecipeExamples()
Collection<Recipe>	listRecipes()
Collection<NamedStyles>	listStyles()

Methods inherited from class java.lang.Object

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

Constructor Details

YamlResourceLoader

public YamlResourceLoader(InputStream yamlInput,
 URI source,
 Properties properties)
                   throws UncheckedIOException

Load a declarative recipe using the runtime classloader

Parameters:

yamlInput - Declarative recipe yaml input stream

source - Declarative recipe source

properties - Placeholder properties

Throws:

UncheckedIOException - On unexpected IOException

YamlResourceLoader

public YamlResourceLoader(InputStream yamlInput,
 URI source,
 Properties properties,
 @Nullable
 @Nullable ClassLoader classLoader)
                   throws UncheckedIOException

Load a declarative recipe, optionally using the specified classloader

Parameters:

yamlInput - Declarative recipe yaml input stream

source - Declarative recipe source

properties - Placeholder properties

classLoader - Optional classloader to use with jackson. If not specified, the runtime classloader will be used.

Throws:

UncheckedIOException - On unexpected IOException

YamlResourceLoader

public YamlResourceLoader(InputStream yamlInput,
 URI source,
 Properties properties,
 @Nullable
 @Nullable ClassLoader classLoader,
 Collection<? extends ResourceLoader> dependencyResourceLoaders)
                   throws UncheckedIOException

Load a declarative recipe, optionally using the specified classloader and optionally including resource loaders for recipes from dependencies.

Parameters:

yamlInput - Declarative recipe yaml input stream

source - Declarative recipe source

properties - Placeholder properties

classLoader - Optional classloader to use with jackson. If not specified, the runtime classloader will be used.

dependencyResourceLoaders - Optional resource loaders for recipes from dependencies

Throws:

UncheckedIOException - On unexpected IOException

YamlResourceLoader

public YamlResourceLoader(InputStream yamlInput,
 URI source,
 Properties properties,
 @Nullable
 @Nullable ClassLoader classLoader,
 Collection<? extends ResourceLoader> dependencyResourceLoaders,
 Consumer<com.fasterxml.jackson.databind.ObjectMapper> mapperCustomizer)

Load a declarative recipe, optionally using the specified classloader and optionally including resource loaders for recipes from dependencies.

Parameters:

yamlInput - Declarative recipe yaml input stream

source - Declarative recipe source

properties - Placeholder properties

classLoader - Optional classloader to use with jackson. If not specified, the runtime classloader will be used.

dependencyResourceLoaders - Optional resource loaders for recipes from dependencies

mapperCustomizer - Customizer for the ObjectMapper

Throws:

UncheckedIOException - On unexpected IOException

Method Details

listRecipes

public Collection<Recipe> listRecipes()

Specified by:

listRecipes in interface ResourceLoader

listRecipeDescriptors

public Collection<RecipeDescriptor> listRecipeDescriptors()

Specified by:

listRecipeDescriptors in interface ResourceLoader

listRecipeDescriptors

public Collection<RecipeDescriptor> listRecipeDescriptors(Collection<Recipe> externalRecipes,
 Map<String,List<Contributor>> recipeNamesToContributors,
 Map<String,List<RecipeExample>> recipeNamesToExamples)

listStyles

public Collection<NamedStyles> listStyles()

Specified by:

listStyles in interface ResourceLoader

listCategoryDescriptors

public Collection<CategoryDescriptor> listCategoryDescriptors()

Specified by:

listCategoryDescriptors in interface ResourceLoader

listRecipeExamples

public Map<String,List<RecipeExample>> listRecipeExamples()

Specified by:

listRecipeExamples in interface ResourceLoader

listContributors

public Map<String,List<Contributor>> listContributors()

Specified by:

listContributors in interface ResourceLoader