org.nuxeo.ecm.core.io.marshallers.json.validation

Class DocumentValidationReportJsonWriter

java.lang.Object

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

org.nuxeo.ecm.core.io.marshallers.json.ExtensibleEntityJsonWriter<DocumentValidationReport>

org.nuxeo.ecm.core.io.marshallers.json.validation.DocumentValidationReportJsonWriter

All Implemented Interfaces:

Marshaller<DocumentValidationReport>, Writer<DocumentValidationReport>

@Setup(mode=SINGLETON,
       priority=2000)
public class DocumentValidationReportJsonWriter
extends ExtensibleEntityJsonWriter<DocumentValidationReport>

Convert DocumentValidationReport to Json.

This marshaller is enrichable: register class implementing AbstractJsonEnricher and managing DocumentValidationReport.

This marshaller is also extensible: extend it and simply override ExtensibleEntityJsonWriter#extend(DocumentValidationReport, JsonWriter).

Format is:

 
 {
   "entity-type":"validation_report",
   "has_error": true|false,
   "number": 123, <- number of errors present in this report
   "violations": [
     {
       "message": "TheErrorMessage",
       "invalid_value": null|"THE_INVALID_VALUE_AS_STRING",
       "constraint": {
         see {@link ConstraintJsonWriter} format
       }
     },
     ...
   ]
             <-- contextParameters if there are enrichers activated
             <-- additional property provided by extend() method
 }
 

Since:

7.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTITY_TYPE

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

ctx, registry

Constructor Summary

Constructors

Constructor and Description
DocumentValidationReportJsonWriter()

Method Summary

Modifier and Type	Method and Description
protected void	writeEntityBody(DocumentValidationReport report, org.codehaus.jackson.JsonGenerator jg) Implement this method to write the entity body.

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

extend, write

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

accept, getGenerator, write, writeEntity, writeEntity, writeEntityField

Methods inherited from class java.lang.Object

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

Field Detail

ENTITY_TYPE

public static final String ENTITY_TYPE

See Also:

Constant Field Values

Constructor Detail

DocumentValidationReportJsonWriter

public DocumentValidationReportJsonWriter()

Method Detail

writeEntityBody

protected void writeEntityBody(DocumentValidationReport report,
                               org.codehaus.jackson.JsonGenerator jg)
                        throws IOException

Description copied from class: ExtensibleEntityJsonWriter

Implement this method to write the entity body.

Specified by:

writeEntityBody in class ExtensibleEntityJsonWriter<DocumentValidationReport>

Parameters:

report - The Java entity.

jg - A JsonGenerator ready to write your entity as Json.

Throws:

IOException