模块 wjybxx.dson.codec
程序包 cn.wjybxx.dsoncodec

接口 DsonObjectWriter

所有超级接口:
AutoCloseable
public interface DsonObjectWriter extends AutoCloseable
如果用户期望强制写入null，需要先调用writeName(String)， 再调用writeNull(String)

1.对于对象类型，如果value为null，将自动调用writeNull(String) 2.数组内元素name传null

注意：不要轻易重命名方法，注解处理器对这里的方法名是有依赖的。

作者:
wjybxx date 2023/4/3

  • 方法详细资料

    • writeInt

      void writeInt(String name, int value, INumberStyle style)

    • writeLong

      void writeLong(String name, long value, INumberStyle style)

    • writeFloat

      void writeFloat(String name, float value, INumberStyle style)

    • writeDouble

      void writeDouble(String name, double value, INumberStyle style)

    • writeBoolean

      void writeBoolean(String name, boolean value)

    • writeString

      void writeString(String name, String value, StringStyle style)

    • writeNull

      void writeNull(String name)

    • writeBytes

      void writeBytes(String name, byte[] value)
      bytes默认为不可共享对象 -- 如果不期望拷贝，可先包装为Binary

    • writeBytes

      void writeBytes(String name, byte[] value, int offset, int len)

    • writeBinary

      void writeBinary(String name, Binary binary)
      Binary默认为可共享对象

    • writePtr

      void writePtr(String name, ObjectPtr objectPtr)

    • writeLitePtr

      void writeLitePtr(String name, ObjectLitePtr objectLitePtr)

    • writeDateTime

      void writeDateTime(String name, LocalDateTime dateTime)

    • writeExtDateTime

      void writeExtDateTime(String name, ExtDateTime dateTime)

    • writeTimestamp

      void writeTimestamp(String name, Timestamp timestamp)

    • writeObject

      <T> void writeObject(String name, T value, cn.wjybxx.base.TypeInfo declaredType, @Nullable ObjectStyle style)
      写嵌套对象
      参数:
      name - 字段的名字，数组元素和顶层对象的name可为null或空字符串
      value - 要写入的对象
      declaredType - 对象的声明类型
      style - 对象的编码风格，如果为null则使用目标类型Codec的默认格式

    • writeObject

      default <T> void writeObject(String name, T value)

    • writeObject

      default <T> void writeObject(String name, T value, cn.wjybxx.base.TypeInfo declaredType)

    • options

      ConverterOptions options()

    • getCurrentName

      String getCurrentName()

    • writeName

      void writeName(String name)

    • writeTypeInfo

      void writeTypeInfo(cn.wjybxx.base.TypeInfo encoderType, cn.wjybxx.base.TypeInfo declaredType)
      写入类型信息 1.该方法应当在writeStartObject/Array后立即调用，写在所有字段之前。 2.默认会调用setEncoderType(TypeInfo)保存类型信息
      参数:
      encoderType - 编码器绑定的类型，真实写入的类型信息
      declaredType - 对象的声明类型，用于测试是否写入类型信息

    • writeStartObject

      void writeStartObject(ObjectStyle style)
      开始写入Object

    • writeEndObject

      void writeEndObject()

    • writeStartArray

      void writeStartArray(ObjectStyle style)
      开始写入Array

    • writeEndArray

      void writeEndArray()

    • writeValueBytes

      void writeValueBytes(String name, DsonType dsonType, byte[] data)
      写入已编码的二进制数据

    • encodeKey

      <T> String encodeKey(T key, cn.wjybxx.base.TypeInfo keyType)
      编码字典的key

    • setEncoderType

      void setEncoderType(cn.wjybxx.base.TypeInfo encoderType)
      设置当前对象的encoderType 1.java特殊支持，用于读写Object/Array期间查询当前对象的类型信息 2.应当在writeStartObject/Array以后调用

    • getEncoderType

      cn.wjybxx.base.TypeInfo getEncoderType()
      获取当前对象的类型信息

    • flush

      void flush()

    • close

      void close()
      指定者:
      close 在接口中 AutoCloseable

    • writeStartObject

      default void writeStartObject(ObjectStyle style, cn.wjybxx.base.TypeInfo encoderType, cn.wjybxx.base.TypeInfo declaredType)

    • writeStartObject

      default void writeStartObject(String name, ObjectStyle style)

    • writeStartObject

      default void writeStartObject(String name, ObjectStyle style, cn.wjybxx.base.TypeInfo encoderType, cn.wjybxx.base.TypeInfo declaredType)

    • writeStartArray

      default void writeStartArray(ObjectStyle style, cn.wjybxx.base.TypeInfo encoderType, cn.wjybxx.base.TypeInfo declaredType)

    • writeStartArray

      default void writeStartArray(String name, ObjectStyle style)

    • writeStartArray

      default void writeStartArray(String name, ObjectStyle style, cn.wjybxx.base.TypeInfo encoderType, cn.wjybxx.base.TypeInfo declaredType)

    • writeInt

      default void writeInt(String name, int value)

    • writeLong

      default void writeLong(String name, long value)

    • writeFloat

      default void writeFloat(String name, float value)

    • writeDouble

      default void writeDouble(String name, double value)

    • writeString

      default void writeString(String name, String value)

    • writeShort

      default void writeShort(String name, short value)
      应当减少 short/byte/char 的使用，尤其应当避免使用其包装类型，使用的越多越难以扩展，越难以支持跨语言等。

    • writeShort

      default void writeShort(String name, short value, INumberStyle style)

    • writeByte

      default void writeByte(String name, byte value)

    • writeByte

      default void writeByte(String name, byte value, INumberStyle style)

    • writeChar

      default void writeChar(String name, char value)

    • writeChar

      default void writeChar(String name, char value, INumberStyle style)