Interface Writer<EntityType>

Type Parameters:
EntityType - The managed Java type.
All Superinterfaces:
Marshaller<EntityType>
All Known Implementing Classes:
AbstractCSVWriter, AbstractJsonEnricher, AbstractJsonWriter, AbstractLayoutJsonWriter, ACLJsonEnricher, ACPJsonWriter, AggregateJsonWriter, AnnotationJsonWriter, AnnotationListJsonWriter, AuditJsonEnricher, AuthenticationTokenListWriter, AuthenticationTokenWriter, BasePermissionsJsonEnricher, BinaryManagerStatusJsonWriter, BlobAppLinksJsonEnricher, BlobPreviewJsonEnricher, BreadcrumbJsonEnricher, BulkCommandJsonWriter, BulkStatusJsonWriter, CapabilitiesJsonWriter, ChildrenJsonEnricher, CollectionsJsonEnricher, CommentJsonWriter, CommentListJsonWriter, ConfigurationPropertiesJsonWriter, ConstraintJsonWriter, ConstraintListJsonWriter, ContextualParametersJsonEnricher, DefaultListJsonWriter, DirectoryEntryJsonWriter, DirectoryEntryListJsonWriter, DirectoryJsonWriter, DirectoryListJsonWriter, DocumentModelCSVWriter, DocumentModelJsonWriter, DocumentModelListCSVWriter, DocumentModelListJsonWriter, DocumentPropertyCSVWriter, DocumentPropertyJsonWriter, DocumentRouteListWriter, DocumentRouteWriter, DocumentTypeJsonWriter, DocumentTypeListJsonWriter, DocumentUrlJsonEnricher, DocumentValidationReportJsonWriter, ExtensibleEntityJsonWriter, FacetJsonWriter, FacetListJsonWriter, FavoritesJsonEnricher, FieldDefinitionJsonWriter, FirstAccessibleAncestorJsonEnricher, GraphRouteWriter, HasContentJsonEnricher, HasFolderishChildJsonEnricher, HighlightJsonEnricher, LayoutDefinitionJsonWriter, LayoutDefinitionsJsonWriter, LayoutJsonWriter, LayoutTypeConfigurationJsonWriter, LayoutTypeDefinitionJsonWriter, LayoutTypeDefinitionsJsonWriter, LogEntryCSVWriter, LogEntryJsonWriter, LogEntryListCSVWriter, LogEntryListJsonWriter, MigrationJsonWriter, MigrationListJsonWriter, NotificationsJsonEnricher, NuxeoGroupJsonWriter, NuxeoGroupListJsonWriter, NuxeoOAuth2ServiceProviderListWriter, NuxeoOAuth2ServiceProviderWriter, NuxeoOAuth2TokenListWriter, NuxeoOAuth2TokenWriter, NuxeoPrincipalJsonWriter, NuxeoPrincipalListJsonWriter, OAuth2ClientListWriter, OAuth2ClientWriter, PendingTasksJsonEnricher, PreviewJsonEnricher, ProbeInfoJsonWriter, ProbeInfoListJsonWriter, ProbeStatusJsonWriter, PublicationJsonEnricher, RenderingInfoJsonWriter, RenditionJsonEnricher, RunnableWorkflowJsonEnricher, RunningWorkflowJsonEnricher, SavedSearchListWriter, SavedSearchWriter, ScheduleJsonWriter, ScheduleListJsonWriter, SchemaJsonWriter, SchemaListJsonWriter, ScimResourceWriter, SequencerJsonWriter, SequencerListJsonWriter, SimplifiedServerInfoJsonWriter, SubtypesJsonEnricher, SubtypesJsonEnricher, TagsJsonEnricher, TaskListWriter, TaskWriter, ThumbnailJsonEnricher, UserProfileEnricher, UserVisiblePermissionsJsonEnricher, WidgetDefinitionJsonWriter, WidgetReferenceJsonWriter, WidgetSelectOptionJsonWriter, WidgetTypeConfigurationJsonWriter, WidgetTypeDefinitionJsonWriter, WidgetTypeDefinitionsJsonWriter, WOPIJsonEnricher

public interface Writer<EntityType> extends Marshaller<EntityType>
Interface of Java type to mimetype converter.

see Marshaller for more details.

Since:
7.2
  • Method Summary

    Modifier and Type
    Method
    Description
    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.

    Methods inherited from interface org.nuxeo.ecm.core.io.registry.Marshaller

    accept
  • Method Details

    • write

      void write(EntityType entity, Class<?> clazz, Type genericType, javax.ws.rs.core.MediaType mediatype, OutputStream out) throws IOException
      Writes the entity to out OutputStream using mediatype format.

      This method implementation can use injected properties.

      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.
      Since:
      7.2