Package org.nuxeo.ecm.platform.types

Class SubtypesJsonEnricher

java.lang.Object

org.nuxeo.ecm.core.io.marshallers.json.AbstractJsonWriter<Enriched<EntityType>>

org.nuxeo.ecm.core.io.marshallers.json.enrichers.AbstractJsonEnricher<DocumentModel>

org.nuxeo.ecm.platform.types.SubtypesJsonEnricher

All Implemented Interfaces:

Marshaller<Enriched<DocumentModel>>, Writer<Enriched<DocumentModel>>

@Setup(mode=SINGLETON,
       priority=2000)
public class SubtypesJsonEnricher
extends AbstractJsonEnricher<DocumentModel>

Enrich DocumentModel JSON object with an array of the document types that can be created under the current document taking account the local configuration.

Since:

11.5

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Fields inherited from class org.nuxeo.ecm.core.io.marshallers.json.enrichers.AbstractJsonEnricher

ENTITY_ENRICHER_NAME, MAPPER

Fields inherited from class org.nuxeo.ecm.core.io.marshallers.json.AbstractJsonWriter

ctx, registry

Constructor Summary

Constructors

Constructor	Description
SubtypesJsonEnricher()

Method Summary

Modifier and Type	Method	Description
protected Collection<String>	computeLocalConfigurationSubtypes(DocumentModel enriched, Collection<String> defaultSubtypes)
protected Collection<String>	computeSubtypes(DocumentModel enriched)
void	write(com.fasterxml.jackson.core.JsonGenerator jg, DocumentModel enriched)	When implementing this method, the provided JsonGenerator expect you write a field name and a field value (or many).

Methods inherited from class org.nuxeo.ecm.core.io.marshallers.json.enrichers.AbstractJsonEnricher

accept, safeReadBuffer, write

Methods inherited from class org.nuxeo.ecm.core.io.marshallers.json.AbstractJsonWriter

getGenerator, write, writeEntity, writeEntity, writeEntityField, writeSerializable, writeSerializableField, writeSerializableListField, writeSerializableMapField

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

SubtypesJsonEnricher

public SubtypesJsonEnricher()

Method Detail

write

public void write(com.fasterxml.jackson.core.JsonGenerator jg,
                  DocumentModel enriched)
           throws IOException

Description copied from class: AbstractJsonEnricher

When implementing this method, the provided JsonGenerator expect you write a field name and a field value (or many).

Specified by:

write in class AbstractJsonEnricher<DocumentModel>

Parameters:

jg - The JsonGenerator to use.

enriched - The enriched entity.

Throws:

IOException

computeSubtypes

protected Collection<String> computeSubtypes(DocumentModel enriched)

computeLocalConfigurationSubtypes

protected Collection<String> computeLocalConfigurationSubtypes(DocumentModel enriched,
                                                               Collection<String> defaultSubtypes)