ResourceFormatGenerator (core 5.3.0-rc1-20240508 API)

All Known Implementing Classes:

ResourceJsonFormatGenerator, ResourceXMLFormatGenerator, ResourceYamlFormatGenerator
```
public interface ResourceFormatGenerator
```
ResourceFormatGenerator generates a resources document from a set of nodes.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`generateDocument(INodeSet nodeset, java.io.OutputStream stream)`	generate formatted output
`java.util.Set<java.lang.String>`	`getFileExtensions()`
`java.util.List<java.lang.String>`	`getMIMETypes()`
`default java.lang.String`	`getPreferredFileExtension()`
`default java.lang.String`	`getPreferredMimeType()`

- Method Detail
  - getFileExtensions
```
java.util.Set<java.lang.String> getFileExtensions()
```
    Returns:
    
    the list of file extensions that this format generator can generate
  - getPreferredFileExtension
```
default java.lang.String getPreferredFileExtension()
```
    Returns:
    
    the single preferred file extension, or null
  - getMIMETypes
```
java.util.List<java.lang.String> getMIMETypes()
```
    Returns:
    
    the list of MIME types that this format generator can generate. If more than one are returned, then the first value will be used by default if necessary.
  - getPreferredMimeType
```
default java.lang.String getPreferredMimeType()
```
    Returns:
    
    the single preferred mime type, or null
  - generateDocument
```
void generateDocument(INodeSet nodeset,
                      java.io.OutputStream stream)
               throws ResourceFormatGeneratorException,
                      java.io.IOException
```
    generate formatted output
    
    Parameters:
    
    nodeset - nodes
    
    stream - output stream
    
    Throws:
    
    java.io.IOException - on io error
    
    ResourceFormatGeneratorException - on format error