Package com.fasterxml.jackson.dataformat.javaprop

Class JavaPropsGenerator

  • All Implemented Interfaces:
    com.fasterxml.jackson.core.Versioned, java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    Direct Known Subclasses:
    PropertiesBackedGenerator, WriterBackedGenerator
    public abstract class JavaPropsGenerator
extends com.fasterxml.jackson.core.base.GeneratorBase

    • Nested Class Summary

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

        com.fasterxml.jackson.core.JsonGenerator.Feature

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.StringBuilder _basePath  
      protected boolean _headerChecked  
      protected int _indentLength  
      protected JPropWriteContext _jpropContext
      Current context, in form we can use it (GeneratorBase has untyped reference; left as null)
      protected JavaPropsSchema _schema
      Definition of columns being written, if available.
      protected com.fasterxml.jackson.core.StreamWriteConstraints _streamWriteConstraints  
      protected static com.fasterxml.jackson.core.json.JsonWriteContext BOGUS_WRITE_CONTEXT
      Since our context object does NOT implement standard write context, need to do something like use a placeholder...
      private static JavaPropsSchema EMPTY_SCHEMA  
      protected static int SHORT_WRITE  

      • Fields inherited from class com.fasterxml.jackson.core.base.GeneratorBase

        _cfgNumbersAsStrings, _closed, _features, _ioContext, _objectCodec, _writeContext, DERIVED_FEATURES_MASK, MAX_BIG_DECIMAL_SCALE, SURR1_FIRST, SURR1_LAST, SURR2_FIRST, SURR2_LAST, WRITE_BINARY, WRITE_BOOLEAN, WRITE_NULL, WRITE_NUMBER, WRITE_RAW, WRITE_STRING

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

        _cfgPrettyPrinter, DEFAULT_BINARY_WRITE_CAPABILITIES, DEFAULT_TEXTUAL_WRITE_CAPABILITIES, DEFAULT_WRITE_CAPABILITIES

    • Constructor Summary

      Constructors 
      Constructor Description
      JavaPropsGenerator​(com.fasterxml.jackson.core.io.IOContext ctxt, int stdFeatures, com.fasterxml.jackson.core.ObjectCodec codec)  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected abstract void _appendFieldName​(java.lang.StringBuilder path, java.lang.String name)  
      protected void _verifyValueWrite​(java.lang.String typeMsg)  
      protected abstract void _writeEscapedEntry​(char[] text, int offset, int len)  
      protected abstract void _writeEscapedEntry​(java.lang.String value)  
      protected abstract void _writeRaw​(char c)  
      protected abstract void _writeRaw​(char[] text, int offset, int len)  
      protected abstract void _writeRaw​(java.lang.String text)  
      protected abstract void _writeRaw​(java.lang.StringBuilder text)  
      protected abstract void _writeUnescapedEntry​(java.lang.String value)  
      void assignCurrentValue​(java.lang.Object v)  
      boolean canOmitFields()  
      boolean canUseSchema​(com.fasterxml.jackson.core.FormatSchema schema)  
      boolean canWriteBinaryNatively()  
      boolean canWriteFormattedNumbers()  
      boolean canWriteObjectId()  
      boolean canWriteTypeId()  
      java.lang.Object currentValue()  
      java.lang.Object getCurrentValue()  
      com.fasterxml.jackson.core.JsonStreamContext getOutputContext()  
      com.fasterxml.jackson.core.FormatSchema getSchema()  
      com.fasterxml.jackson.core.util.JacksonFeatureSet<com.fasterxml.jackson.core.StreamWriteCapability> getWriteCapabilities()  
      void setCurrentValue​(java.lang.Object v)  
      com.fasterxml.jackson.core.JsonGenerator setPrettyPrinter​(com.fasterxml.jackson.core.PrettyPrinter pp)  
      void setSchema​(com.fasterxml.jackson.core.FormatSchema schema)  
      com.fasterxml.jackson.core.StreamWriteConstraints streamWriteConstraints()  
      com.fasterxml.jackson.core.JsonGenerator useDefaultPrettyPrinter()  
      com.fasterxml.jackson.core.Version version()  
      void writeBinary​(com.fasterxml.jackson.core.Base64Variant b64variant, byte[] data, int offset, int len)  
      void writeBoolean​(boolean state)  
      void writeEndArray()  
      void writeEndObject()  
      void writeFieldName​(java.lang.String name)  
      void writeNull()  
      void writeNumber​(double d)  
      void writeNumber​(float f)  
      void writeNumber​(int i)  
      void writeNumber​(long l)  
      void writeNumber​(java.lang.String encodedValue)  
      void writeNumber​(java.math.BigDecimal dec)  
      void writeNumber​(java.math.BigInteger v)  
      void writeRaw​(char c)  
      void writeRaw​(char[] text, int offset, int len)  
      void writeRaw​(com.fasterxml.jackson.core.SerializableString text)  
      void writeRaw​(java.lang.String text)  
      void writeRaw​(java.lang.String text, int offset, int len)  
      void writeRawUTF8String​(byte[] text, int offset, int len)  
      void writeStartArray()  
      void writeStartObject()  
      void writeString​(char[] text, int offset, int len)  
      void writeString​(java.lang.String text)  
      void writeUTF8String​(byte[] text, int offset, int len)  

      • Methods inherited from class com.fasterxml.jackson.core.base.GeneratorBase

        _asString, _checkRangeBoundsForByteArray, _checkRangeBoundsForCharArray, _checkRangeBoundsForString, _checkStdFeatureChanges, _constructDefaultPrettyPrinter, _decodeSurrogate, _releaseBuffers, close, disable, enable, flush, getCodec, getFeatureMask, ioContext, isClosed, isEnabled, overrideStdFeatures, setCodec, setFeatureMask, writeBinary, writeFieldName, writeObject, writeRawValue, writeRawValue, writeRawValue, writeRawValue, writeStartObject, writeString, writeTree

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

        _constructWriteException, _constructWriteException, _constructWriteException, _constructWriteException, _copyCurrentContents, _copyCurrentFloatValue, _copyCurrentFloatValueExact, _copyCurrentIntValue, _copyCurrentStringValue, _reportError, _reportUnsupportedOperation, _reportUnsupportedOperation, _throwInternal, _verifyOffsets, _writeSimpleObject, configure, copyCurrentEvent, copyCurrentEventExact, copyCurrentStructure, getCharacterEscapes, getFormatFeatures, getHighestEscapedChar, getOutputBuffered, getOutputTarget, getPrettyPrinter, isEnabled, overrideFormatFeatures, setCharacterEscapes, setHighestNonEscapedChar, setRootValueSeparator, writeArray, writeArray, writeArray, writeArray, writeArrayFieldStart, writeBinary, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeEmbeddedObject, writeFieldId, writeNullField, writeNumber, writeNumber, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writeObjectId, writeObjectRef, writeOmittedField, writePOJO, writePOJOField, writeStartArray, writeStartArray, writeStartArray, writeStartObject, writeString, writeStringField, writeTypeId, writeTypePrefix, writeTypeSuffix

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • BOGUS_WRITE_CONTEXT

        protected static final com.fasterxml.jackson.core.json.JsonWriteContext BOGUS_WRITE_CONTEXT
        Since our context object does NOT implement standard write context, need to do something like use a placeholder...

      • _streamWriteConstraints

        protected final com.fasterxml.jackson.core.StreamWriteConstraints _streamWriteConstraints
        Since:
        2.16

      • _schema

        protected JavaPropsSchema _schema
        Definition of columns being written, if available.

      • _jpropContext

        protected JPropWriteContext _jpropContext
        Current context, in form we can use it (GeneratorBase has untyped reference; left as null)

      • _basePath

        protected final java.lang.StringBuilder _basePath

      • _headerChecked

        protected boolean _headerChecked

      • _indentLength

        protected int _indentLength

    • Constructor Detail

      • JavaPropsGenerator

        public JavaPropsGenerator​(com.fasterxml.jackson.core.io.IOContext ctxt,
                          int stdFeatures,
                          com.fasterxml.jackson.core.ObjectCodec codec)

    • Method Detail

      • streamWriteConstraints

        public com.fasterxml.jackson.core.StreamWriteConstraints streamWriteConstraints()
        Overrides:
        streamWriteConstraints in class com.fasterxml.jackson.core.JsonGenerator

      • currentValue

        public java.lang.Object currentValue()
        Overrides:
        currentValue in class com.fasterxml.jackson.core.base.GeneratorBase

      • getCurrentValue

        public java.lang.Object getCurrentValue()
        Overrides:
        getCurrentValue in class com.fasterxml.jackson.core.JsonGenerator

      • assignCurrentValue

        public void assignCurrentValue​(java.lang.Object v)
        Overrides:
        assignCurrentValue in class com.fasterxml.jackson.core.base.GeneratorBase

      • setCurrentValue

        public void setCurrentValue​(java.lang.Object v)
        Overrides:
        setCurrentValue in class com.fasterxml.jackson.core.JsonGenerator

      • version

        public com.fasterxml.jackson.core.Version version()
        Specified by:
        version in interface com.fasterxml.jackson.core.Versioned
        Overrides:
        version in class com.fasterxml.jackson.core.base.GeneratorBase

      • useDefaultPrettyPrinter

        public com.fasterxml.jackson.core.JsonGenerator useDefaultPrettyPrinter()
        Overrides:
        useDefaultPrettyPrinter in class com.fasterxml.jackson.core.base.GeneratorBase

      • setPrettyPrinter

        public com.fasterxml.jackson.core.JsonGenerator setPrettyPrinter​(com.fasterxml.jackson.core.PrettyPrinter pp)
        Overrides:
        setPrettyPrinter in class com.fasterxml.jackson.core.JsonGenerator

      • setSchema

        public void setSchema​(com.fasterxml.jackson.core.FormatSchema schema)
        Overrides:
        setSchema in class com.fasterxml.jackson.core.JsonGenerator

      • getSchema

        public com.fasterxml.jackson.core.FormatSchema getSchema()
        Overrides:
        getSchema in class com.fasterxml.jackson.core.JsonGenerator

      • canUseSchema

        public boolean canUseSchema​(com.fasterxml.jackson.core.FormatSchema schema)
        Overrides:
        canUseSchema in class com.fasterxml.jackson.core.JsonGenerator

      • canWriteObjectId

        public boolean canWriteObjectId()
        Overrides:
        canWriteObjectId in class com.fasterxml.jackson.core.JsonGenerator

      • canWriteTypeId

        public boolean canWriteTypeId()
        Overrides:
        canWriteTypeId in class com.fasterxml.jackson.core.JsonGenerator

      • canWriteBinaryNatively

        public boolean canWriteBinaryNatively()
        Overrides:
        canWriteBinaryNatively in class com.fasterxml.jackson.core.JsonGenerator

      • canOmitFields

        public boolean canOmitFields()
        Overrides:
        canOmitFields in class com.fasterxml.jackson.core.JsonGenerator

      • canWriteFormattedNumbers

        public boolean canWriteFormattedNumbers()
        Overrides:
        canWriteFormattedNumbers in class com.fasterxml.jackson.core.JsonGenerator

      • getWriteCapabilities

        public com.fasterxml.jackson.core.util.JacksonFeatureSet<com.fasterxml.jackson.core.StreamWriteCapability> getWriteCapabilities()
        Overrides:
        getWriteCapabilities in class com.fasterxml.jackson.core.JsonGenerator

      • getOutputContext

        public com.fasterxml.jackson.core.JsonStreamContext getOutputContext()
        Overrides:
        getOutputContext in class com.fasterxml.jackson.core.base.GeneratorBase

      • writeFieldName

        public void writeFieldName​(java.lang.String name)
                    throws java.io.IOException
        Specified by:
        writeFieldName in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • _appendFieldName

        protected abstract void _appendFieldName​(java.lang.StringBuilder path,
                                         java.lang.String name)

      • writeStartArray

        public void writeStartArray()
                     throws java.io.IOException
        Specified by:
        writeStartArray in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeEndArray

        public void writeEndArray()
                   throws java.io.IOException
        Specified by:
        writeEndArray in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeStartObject

        public void writeStartObject()
                      throws java.io.IOException
        Specified by:
        writeStartObject in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeEndObject

        public void writeEndObject()
                    throws java.io.IOException
        Specified by:
        writeEndObject in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeString

        public void writeString​(java.lang.String text)
                 throws java.io.IOException
        Specified by:
        writeString in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeString

        public void writeString​(char[] text,
                        int offset,
                        int len)
                 throws java.io.IOException
        Specified by:
        writeString in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeRawUTF8String

        public void writeRawUTF8String​(byte[] text,
                               int offset,
                               int len)
                        throws java.io.IOException
        Specified by:
        writeRawUTF8String in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeUTF8String

        public void writeUTF8String​(byte[] text,
                            int offset,
                            int len)
                     throws java.io.IOException
        Specified by:
        writeUTF8String in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeRaw

        public void writeRaw​(java.lang.String text)
              throws java.io.IOException
        Specified by:
        writeRaw in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeRaw

        public void writeRaw​(java.lang.String text,
                     int offset,
                     int len)
              throws java.io.IOException
        Specified by:
        writeRaw in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeRaw

        public void writeRaw​(char[] text,
                     int offset,
                     int len)
              throws java.io.IOException
        Specified by:
        writeRaw in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeRaw

        public void writeRaw​(char c)
              throws java.io.IOException
        Specified by:
        writeRaw in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeRaw

        public void writeRaw​(com.fasterxml.jackson.core.SerializableString text)
              throws java.io.IOException,
                     com.fasterxml.jackson.core.JsonGenerationException
        Overrides:
        writeRaw in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException
        com.fasterxml.jackson.core.JsonGenerationException

      • writeBinary

        public void writeBinary​(com.fasterxml.jackson.core.Base64Variant b64variant,
                        byte[] data,
                        int offset,
                        int len)
                 throws java.io.IOException
        Specified by:
        writeBinary in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeBoolean

        public void writeBoolean​(boolean state)
                  throws java.io.IOException
        Specified by:
        writeBoolean in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeNumber

        public void writeNumber​(int i)
                 throws java.io.IOException
        Specified by:
        writeNumber in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeNumber

        public void writeNumber​(long l)
                 throws java.io.IOException
        Specified by:
        writeNumber in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeNumber

        public void writeNumber​(java.math.BigInteger v)
                 throws java.io.IOException
        Specified by:
        writeNumber in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeNumber

        public void writeNumber​(double d)
                 throws java.io.IOException
        Specified by:
        writeNumber in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeNumber

        public void writeNumber​(float f)
                 throws java.io.IOException
        Specified by:
        writeNumber in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeNumber

        public void writeNumber​(java.math.BigDecimal dec)
                 throws java.io.IOException
        Specified by:
        writeNumber in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeNumber

        public void writeNumber​(java.lang.String encodedValue)
                 throws java.io.IOException
        Specified by:
        writeNumber in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • writeNull

        public void writeNull()
               throws java.io.IOException
        Specified by:
        writeNull in class com.fasterxml.jackson.core.JsonGenerator
        Throws:
        java.io.IOException

      • _verifyValueWrite

        protected void _verifyValueWrite​(java.lang.String typeMsg)
                          throws java.io.IOException
        Specified by:
        _verifyValueWrite in class com.fasterxml.jackson.core.base.GeneratorBase
        Throws:
        java.io.IOException

      • _writeEscapedEntry

        protected abstract void _writeEscapedEntry​(java.lang.String value)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • _writeEscapedEntry

        protected abstract void _writeEscapedEntry​(char[] text,
                                           int offset,
                                           int len)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • _writeUnescapedEntry

        protected abstract void _writeUnescapedEntry​(java.lang.String value)
                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • _writeRaw

        protected abstract void _writeRaw​(char c)
                           throws java.io.IOException
        Throws:
        java.io.IOException

      • _writeRaw

        protected abstract void _writeRaw​(java.lang.String text)
                           throws java.io.IOException
        Throws:
        java.io.IOException

      • _writeRaw

        protected abstract void _writeRaw​(java.lang.StringBuilder text)
                           throws java.io.IOException
        Throws:
        java.io.IOException

      • _writeRaw

        protected abstract void _writeRaw​(char[] text,
                                  int offset,
                                  int len)
                           throws java.io.IOException
        Throws:
        java.io.IOException