Package org.nuxeo.ecm.core.io.marshallers.puml

Class AbstractPlantUMLWriter<EntityType>

java.lang.Object

org.nuxeo.ecm.core.io.marshallers.puml.AbstractPlantUMLWriter<EntityType>

All Implemented Interfaces:

Marshaller<EntityType>, Writer<EntityType>

Direct Known Subclasses:

StreamIntrospectionPlantUMLWriter

@Supports("text/vnd.plantuml")
public abstract class AbstractPlantUMLWriter<EntityType>
extends Object
implements Writer<EntityType>

Since:

2025.12

Field Summary

Fields

Modifier and Type	Field	Description
protected RenderingContext	ctx

Constructor Summary

Constructors

Constructor	Description
AbstractPlantUMLWriter()

Method Summary

Modifier and Type	Method	Description
boolean	accept(Class<?> clazz, Type genericType, javax.ws.rs.core.MediaType mediatype)	Checks if this marshaller can handle the marshalling request.
protected PlantUMLPrinter	getPumlPrinter(OutputStream out)
final void	write(EntityType entity, Class<?> clazz, Type genericType, javax.ws.rs.core.MediaType mediatype, OutputStream out)	Writes the entity to out OutputStream using mediatype format.
protected abstract void	write(EntityType entity, PlantUMLPrinter pumlPrinter)

Methods inherited from class java.lang.Object

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

Field Details

ctx

@Inject
protected RenderingContext ctx

Constructor Details

AbstractPlantUMLWriter

public AbstractPlantUMLWriter()

Method Details

accept

public boolean accept(Class<?> clazz,
 Type genericType,
 javax.ws.rs.core.MediaType mediatype)

Description copied from interface: Marshaller

Checks if this marshaller can handle the marshalling request.

Please note it's useless to check that clazz is an instance of EntityType or if generic type and entity type are compatible (unlike JAX-RS which just checks the clazz, not the generic type). It's also useless to check Supports is compatible with mediatype. This is already done by the MarshallerRegistry

This method implementation can use injected properties. So you can check the current RenderingContext to accept or reject a marshalling request.

Specified by:

accept in interface Marshaller<EntityType>

Parameters:

clazz - The type to marshall.

genericType - The generic type to marshall.

mediatype - The managed mimetype.

Returns:

true if this converter handle the request, false otherwise.

write

public final void write(EntityType entity,
 Class<?> clazz,
 Type genericType,
 javax.ws.rs.core.MediaType mediatype,
 OutputStream out)
                 throws IOException

Description copied from interface: Writer

Writes the entity to out OutputStream using mediatype format.

This method implementation can use injected properties.

Specified by:

write in interface Writer<EntityType>

Parameters:

entity - The entity to marshall.

clazz - The requested marshalled class.

genericType - The requested marshalled generic type.

mediatype - The target mediatype.

out - The output of this marshaller.

Throws:

IOException - If some error append while writing entity to out.

write

protected abstract void write(EntityType entity,
 PlantUMLPrinter pumlPrinter)
                       throws IOException

Throws:

IOException

getPumlPrinter

protected PlantUMLPrinter getPumlPrinter(OutputStream out)