org.nuxeo.ecm.automation.jaxrs.io

Class EntityListWriter<T>

java.lang.Object

org.nuxeo.ecm.automation.jaxrs.io.EntityWriter<List<T>>

org.nuxeo.ecm.automation.jaxrs.io.EntityListWriter<T>

All Implemented Interfaces:

javax.ws.rs.ext.MessageBodyWriter<List<T>>

Direct Known Subclasses:

BusinessAdapterListWriter, DirectoryEntriesWriter, DocumentRouteListWriter, JsonDocumentListWriter, LogEntryListWriter, NuxeoGroupListWriter, NuxeoPrincipalListWriter, TaskListWriter

public abstract class EntityListWriter<T>
extends EntityWriter<List<T>>

Abstract class that knows how to serialize List of nuxeo entities. The implementing classes should only implement getEntityType() and writeItem(JsonGenerator, Object)

Since:

5.7.3

Field Summary

Fields inherited from class org.nuxeo.ecm.automation.jaxrs.io.EntityWriter

factory

Constructor Summary

Constructors

Constructor and Description
EntityListWriter()

Method Summary

Modifier and Type	Method and Description
protected abstract String	getEntityType() Returns the entity-type value of the list (ie: users, groups....)
boolean	isWriteable(Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)
protected void	writeEntityBody(org.codehaus.jackson.JsonGenerator jg, List<T> list) Write the body of the entity.
protected void	writeHeader(org.codehaus.jackson.JsonGenerator jg, List<T> list) Override this method to write into list header
protected abstract void	writeItem(org.codehaus.jackson.JsonGenerator jg, T item) Writes the item in a JsonGenerator.
protected void	writePaginableHeader(org.codehaus.jackson.JsonGenerator jg, List<T> list)

Methods inherited from class org.nuxeo.ecm.automation.jaxrs.io.EntityWriter

getSize, writeEntity, writeTo

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityListWriter

public EntityListWriter()

Method Detail

getEntityType

protected abstract String getEntityType()

Returns the entity-type value of the list (ie: users, groups....)

Specified by:

getEntityType in class EntityWriter<List<T>>

Returns:

the string representing the entity-type.

writeItem

protected abstract void writeItem(org.codehaus.jackson.JsonGenerator jg,
                                  T item)
                           throws IOException

Writes the item in a JsonGenerator.

Throws:

IOException

isWriteable

public boolean isWriteable(Class<?> type,
                           Type genericType,
                           Annotation[] annotations,
                           javax.ws.rs.core.MediaType mediaType)

Specified by:

isWriteable in interface javax.ws.rs.ext.MessageBodyWriter<List<T>>

Overrides:

isWriteable in class EntityWriter<List<T>>

writeEntityBody

protected void writeEntityBody(org.codehaus.jackson.JsonGenerator jg,
                               List<T> list)
                        throws IOException

Description copied from class: EntityWriter

Write the body of the entity. The object has already been opened and it entity-type rendered.

Specified by:

writeEntityBody in class EntityWriter<List<T>>

Throws:

IOException

writePaginableHeader

protected void writePaginableHeader(org.codehaus.jackson.JsonGenerator jg,
                                    List<T> list)
                             throws IOException

Throws:

IOException

writeHeader

protected void writeHeader(org.codehaus.jackson.JsonGenerator jg,
                           List<T> list)
                    throws IOException

Override this method to write into list header

Throws:

IOException