org.apache.sling.models.export.spi

Interface ModelExporter

@ConsumerType
public interface ModelExporter

SPI interface for model exporters.

Method Summary

Modifier and Type	Method and Description
<T> T	export(@NotNull java.lang.Object model, @NotNull java.lang.Class<T> clazz, @NotNull java.util.Map<java.lang.String,java.lang.String> options) Export the provided model to the defined class using the options.
@NotNull java.lang.String	getName() The name of the exporter.
boolean	isSupported(@NotNull java.lang.Class<?> clazz) Check if the result class is supported by this exporter.

Method Detail

isSupported

boolean isSupported(@NotNull
                    @NotNull java.lang.Class<?> clazz)

Check if the result class is supported by this exporter.

Parameters:

clazz - the result class

Returns:

true if the result class is supported

export

@Nullable
<T> T export(@NotNull
                       @NotNull java.lang.Object model,
                       @NotNull
                       @NotNull java.lang.Class<T> clazz,
                       @NotNull
                       @NotNull java.util.Map<java.lang.String,java.lang.String> options)
                throws ExportException

Export the provided model to the defined class using the options.

Type Parameters:

T - the export type

Parameters:

model - the model class

clazz - the export type

options - export options

Returns:

an exported object

Throws:

ExportException - if the export is not successful

getName

@NotNull
@NotNull java.lang.String getName()

The name of the exporter.

Returns:

the name of the exporter