org.elasticsearch.common.xcontent.support.filtering

Class FilteringJsonGenerator

java.lang.Object

com.fasterxml.jackson.core.JsonGenerator

com.fasterxml.jackson.core.util.JsonGeneratorDelegate

org.elasticsearch.common.xcontent.json.BaseJsonGenerator

org.elasticsearch.common.xcontent.support.filtering.FilteringJsonGenerator

All Implemented Interfaces:

com.fasterxml.jackson.core.Versioned, Closeable, Flushable, AutoCloseable

public class FilteringJsonGenerator
extends BaseJsonGenerator

A FilteringJsonGenerator uses antpath-like filters to include/exclude fields when writing XContent streams. When writing a XContent stream, this class instantiates (or reuses) a FilterContext instance for each field (or property) that must be generated. This filter context is used to check if the field/property must be written according to the current list of XContentFilter filters.

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonGenerator

com.fasterxml.jackson.core.JsonGenerator.Feature

Field Summary

Fields inherited from class org.elasticsearch.common.xcontent.json.BaseJsonGenerator

base

Fields inherited from class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

delegate, delegateCopyMethods

Fields inherited from class com.fasterxml.jackson.core.JsonGenerator

_cfgPrettyPrinter

Constructor Summary

Constructors

Constructor and Description
FilteringJsonGenerator(com.fasterxml.jackson.core.JsonGenerator generator, String[] filters)

Method Summary

Modifier and Type	Method and Description
void	close()
void	copyCurrentEvent(com.fasterxml.jackson.core.JsonParser jp)
void	copyCurrentStructure(com.fasterxml.jackson.core.JsonParser jp)
void	writeBinary(com.fasterxml.jackson.core.Base64Variant b64variant, byte[] data, int offset, int len)
int	writeBinary(com.fasterxml.jackson.core.Base64Variant b64variant, InputStream data, int dataLength)
void	writeBoolean(boolean state)
void	writeEndArray()
void	writeEndObject()
void	writeFieldName(com.fasterxml.jackson.core.SerializableString name)
void	writeFieldName(String name)
void	writeNull()
void	writeNumber(BigDecimal v)
void	writeNumber(BigInteger v)
void	writeNumber(double v)
void	writeNumber(float v)
void	writeNumber(int v)
void	writeNumber(long v)
void	writeNumber(short v)
void	writeNumber(String encodedValue)
void	writeRaw(char c)
void	writeRaw(char[] text, int offset, int len)
void	writeRaw(com.fasterxml.jackson.core.SerializableString raw)
void	writeRaw(String text)
void	writeRaw(String text, int offset, int len)
void	writeRawUTF8String(byte[] text, int offset, int length)
protected void	writeRawValue(byte[] content, int offset, int length, OutputStream bos)
protected void	writeRawValue(byte[] content, OutputStream bos)
protected void	writeRawValue(BytesReference content, OutputStream bos)
void	writeRawValue(char[] text, int offset, int len)
protected void	writeRawValue(InputStream content, OutputStream bos)
void	writeRawValue(String text)
void	writeRawValue(String text, int offset, int len)
void	writeStartArray()
void	writeStartArray(int size)
void	writeStartObject()
void	writeString(char[] text, int offset, int len)
void	writeString(com.fasterxml.jackson.core.SerializableString text)
void	writeString(String text)
void	writeUTF8String(byte[] text, int offset, int length)

Methods inherited from class org.elasticsearch.common.xcontent.json.BaseJsonGenerator

writeEndRaw, writeStartRaw

Methods inherited from class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

canOmitFields, canUseSchema, canWriteBinaryNatively, canWriteObjectId, canWriteTypeId, disable, enable, flush, getCharacterEscapes, getCodec, getCurrentValue, getDelegate, getFeatureMask, getHighestEscapedChar, getOutputContext, getOutputTarget, getPrettyPrinter, getSchema, isClosed, isEnabled, setCharacterEscapes, setCodec, setCurrentValue, setFeatureMask, setHighestNonEscapedChar, setPrettyPrinter, setRootValueSeparator, setSchema, useDefaultPrettyPrinter, version, writeObject, writeObjectId, writeObjectRef, writeOmittedField, writeTree, writeTypeId

Methods inherited from class com.fasterxml.jackson.core.JsonGenerator

_reportError, _reportUnsupportedOperation, _throwInternal, _writeSimpleObject, configure, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeRawValue, writeStringField

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteringJsonGenerator

public FilteringJsonGenerator(com.fasterxml.jackson.core.JsonGenerator generator,
                              String[] filters)

Method Detail

writeStartArray

public void writeStartArray()
                     throws IOException

Overrides:

writeStartArray in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeStartArray

public void writeStartArray(int size)
                     throws IOException

Overrides:

writeStartArray in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeEndArray

public void writeEndArray()
                   throws IOException

Overrides:

writeEndArray in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeStartObject

public void writeStartObject()
                      throws IOException

Overrides:

writeStartObject in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeEndObject

public void writeEndObject()
                    throws IOException

Overrides:

writeEndObject in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeFieldName

public void writeFieldName(String name)
                    throws IOException

Overrides:

writeFieldName in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeFieldName

public void writeFieldName(com.fasterxml.jackson.core.SerializableString name)
                    throws IOException

Overrides:

writeFieldName in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeString

public void writeString(String text)
                 throws IOException

Overrides:

writeString in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeString

public void writeString(char[] text,
                        int offset,
                        int len)
                 throws IOException

Overrides:

writeString in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeString

public void writeString(com.fasterxml.jackson.core.SerializableString text)
                 throws IOException

Overrides:

writeString in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeRawUTF8String

public void writeRawUTF8String(byte[] text,
                               int offset,
                               int length)
                        throws IOException

Overrides:

writeRawUTF8String in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeUTF8String

public void writeUTF8String(byte[] text,
                            int offset,
                            int length)
                     throws IOException

Overrides:

writeUTF8String in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeRaw

public void writeRaw(String text)
              throws IOException

Overrides:

writeRaw in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeRaw

public void writeRaw(String text,
                     int offset,
                     int len)
              throws IOException

Overrides:

writeRaw in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeRaw

public void writeRaw(com.fasterxml.jackson.core.SerializableString raw)
              throws IOException

Overrides:

writeRaw in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeRaw

public void writeRaw(char[] text,
                     int offset,
                     int len)
              throws IOException

Overrides:

writeRaw in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeRaw

public void writeRaw(char c)
              throws IOException

Overrides:

writeRaw in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeRawValue

public void writeRawValue(String text)
                   throws IOException

Overrides:

writeRawValue in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeRawValue

public void writeRawValue(String text,
                          int offset,
                          int len)
                   throws IOException

Overrides:

writeRawValue in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeRawValue

public void writeRawValue(char[] text,
                          int offset,
                          int len)
                   throws IOException

Overrides:

writeRawValue in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeBinary

public void writeBinary(com.fasterxml.jackson.core.Base64Variant b64variant,
                        byte[] data,
                        int offset,
                        int len)
                 throws IOException

Overrides:

writeBinary in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeBinary

public int writeBinary(com.fasterxml.jackson.core.Base64Variant b64variant,
                       InputStream data,
                       int dataLength)
                throws IOException

Overrides:

writeBinary in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(short v)
                 throws IOException

Overrides:

writeNumber in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(int v)
                 throws IOException

Overrides:

writeNumber in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(long v)
                 throws IOException

Overrides:

writeNumber in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(BigInteger v)
                 throws IOException

Overrides:

writeNumber in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(double v)
                 throws IOException

Overrides:

writeNumber in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(float v)
                 throws IOException

Overrides:

writeNumber in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(BigDecimal v)
                 throws IOException

Overrides:

writeNumber in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(String encodedValue)
                 throws IOException,
                        UnsupportedOperationException

Overrides:

writeNumber in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

UnsupportedOperationException

writeBoolean

public void writeBoolean(boolean state)
                  throws IOException

Overrides:

writeBoolean in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeNull

public void writeNull()
               throws IOException

Overrides:

writeNull in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

copyCurrentEvent

public void copyCurrentEvent(com.fasterxml.jackson.core.JsonParser jp)
                      throws IOException

Overrides:

copyCurrentEvent in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

copyCurrentStructure

public void copyCurrentStructure(com.fasterxml.jackson.core.JsonParser jp)
                          throws IOException

Overrides:

copyCurrentStructure in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException

writeRawValue

protected void writeRawValue(byte[] content,
                             OutputStream bos)
                      throws IOException

Overrides:

writeRawValue in class BaseJsonGenerator

Throws:

IOException

writeRawValue

protected void writeRawValue(byte[] content,
                             int offset,
                             int length,
                             OutputStream bos)
                      throws IOException

Overrides:

writeRawValue in class BaseJsonGenerator

Throws:

IOException

writeRawValue

protected void writeRawValue(InputStream content,
                             OutputStream bos)
                      throws IOException

Overrides:

writeRawValue in class BaseJsonGenerator

Throws:

IOException

writeRawValue

protected void writeRawValue(BytesReference content,
                             OutputStream bos)
                      throws IOException

Overrides:

writeRawValue in class BaseJsonGenerator

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

Throws:

IOException