com.adobe.aemds.guide.transformer.api.ResourcePropertyTransformer Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * ADOBE CONFIDENTIAL
 * ___________________
 * Copyright 2015 Adobe Systems Incorporated
 * All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by all applicable intellectual property
 * laws, including trade secret and copyright laws.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 ******************************************************************************/

package com.adobe.aemds.guide.transformer.api;

import org.apache.sling.api.resource.Resource;
import org.apache.sling.commons.json.JSONException;
import org.apache.sling.commons.json.JSONObject;

/**
 * @pad.exclude Exclude from Published API.
 */
public interface ResourcePropertyTransformer {

    /**
     * Transform the resource into a JSONObject.
     * @param resource Resource whose JSON representation has to be returned
     * @param parentSOM
     * @return  JSON Object of the resource
     * @throws JSONException
     */
    public JSONObject transform(final Resource resource, String parentSOM) throws JSONException;

}