org.cuberact.json.builder.JsonBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cuberact-json Show documentation

Fast JSON parser with highly customizable input, output and builder.

There is a newer version: 1.6.0

/*
 * Copyright 2017 Michal Nikodim
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.cuberact.json.builder;

import org.cuberact.json.builder.number.NumberConverter;
import org.cuberact.json.parser.JsonParser;

/**
 * Used by {@link JsonParser#JsonParser(JsonBuilder)} for build Json tree
 *
 * @author Michal Nikodim ([email protected])
 */
public interface JsonBuilder {

    JsonBuilder DEFAULT = new JsonBuilderTree();

    /**
     * @return json object representation
     */
    Object createJsonObject();

    /**
     * @return json array representation
     */
    Object createJsonArray();

    /**
     * @param jsonObject - json object representation created by {@link JsonBuilder#createJsonObject()}
     * @param attr       - attribute name
     * @param value      - attribute value
     */
    void addToJsonObject(Object jsonObject, String attr, Object value);

    /**
     * @param jsonArray - json array representation created by {@link JsonBuilder#createJsonArray()}
     * @param value     - array item value
     */
    void addToJsonArray(Object jsonArray, Object value);

    /**
     * @return NumberConverter
     * {@link NumberConverter}
     */
    NumberConverter getNumberConverter();
}