remote-content-api/document-aggregator/src/main/java/org/apache/sling/documentaggregator/api/DocumentTree.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.sling.documentaggregator.api;

import org.apache.sling.api.adapter.Adaptable;
import org.jetbrains.annotations.NotNull;
import org.osgi.annotation.versioning.ProviderType;

/**
 * A target for content mapping, usually implemented by a Map of Maps, a JSON
 * document tree, etc.
 */
@ProviderType
public interface DocumentTree {
    String TARGET_TYPE = "sling.mapping.target.type";

    interface DocumentNode extends Adaptable {
        DocumentNode addChild(String name);
        DocumentNode addValue(String name, Object value);
        DocumentNode addValue(String name, Object [] value);
        void close();
    }

    @NotNull DocumentNode newTargetNode();
}