com.dahuatech.hutool.json.JSON Maven / Gradle / Ivy

Go to download
package com.dahuatech.hutool.json;

import com.dahuatech.hutool.core.bean.BeanPath;

import java.io.Serializable;
import java.io.Writer;

/**
 * JSON接口
 *
 * @author Looly
 */
public interface JSON extends Cloneable, Serializable {

  /**
   * 通过表达式获取JSON中嵌套的对象

   *
   * 
   *   .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
   *   
[]表达式，可以获取集合等对象中对应index的值
   * 
   *
   * 表达式栗子：
   *
   *    * persion
   * persion.name
   * persons[3]
   * person.friends[5].name
   * 
   *
   * @param expression 表达式
   * @return 对象
   * @see BeanPath#get(Object)
   * @since 4.0.6
   */
  Object getByPath(String expression);

  /**
   * 设置表达式指定位置（或filed对应）的值

   * 若表达式指向一个JSONArray则设置其坐标对应位置的值，若指向JSONObject则put对应key的值

   * 注意：如果为JSONArray，设置值下标小于其长度，将替换原有值，否则追加新值

   *
   * 
   *   .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
   *   
[]表达式，可以获取集合等对象中对应index的值
   * 
   *
   * 表达式栗子：
   *
   *    * persion
   * persion.name
   * persons[3]
   * person.friends[5].name
   * 
   *
   * @param expression 表达式
   * @param value 值
   */
  public void putByPath(String expression, Object value);

  /**
   * 通过表达式获取JSON中嵌套的对象

   *
   * 
   *   .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
   *   
[]表达式，可以获取集合等对象中对应index的值
   * 
   *
   * 表达式栗子：
   *
   *    * persion
   * persion.name
   * persons[3]
   * person.friends[5].name
   * 
   *
   * 获取表达式对应值后转换为对应类型的值
   *
   * @param  返回值类型
   * @param expression 表达式
   * @param resultType 返回值类型
   * @return 对象
   * @see BeanPath#get(Object)
   * @since 4.0.6
   */
   T getByPath(String expression, Class resultType);

  /**
   * 将JSON内容写入Writer，无缩进

   * Warning: This method assumes that the data structure is acyclical.
   *
   * @param writer Writer
   * @return Writer
   * @throws JSONException JSON相关异常
   */
  Writer write(Writer writer) throws JSONException;

  /**
   * 将JSON内容写入Writer

   * Warning: This method assumes that the data structure is acyclical.
   *
   * @param writer writer
   * @param indentFactor 缩进因子，定义每一级别增加的缩进量
   * @param indent 本级别缩进量
   * @return Writer
   * @throws JSONException JSON相关异常
   */
  Writer write(Writer writer, int indentFactor, int indent) throws JSONException;

  /**
   * 转换为JSON字符串
   *
   * @param indentFactor 缩进因子，定义每一级别增加的缩进量
   * @return JSON字符串
   * @throws JSONException JSON相关异常
   */
  String toJSONString(int indentFactor) throws JSONException;

  /**
   * 格式化打印JSON，缩进为4个空格
   *
   * @return 格式化后的JSON字符串
   * @throws JSONException 包含非法数抛出此异常
   * @since 3.0.9
   */
  String toStringPretty() throws JSONException;
}