com.adobe.acs.commons.quickly.results.ResultSerializer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of acs-aem-commons-bundle Show documentation

Main ACS AEM Commons OSGi Bundle. Includes commons utilities.

There is a newer version: 6.6.0

Show newest version

/*
 * #%L
 * ACS AEM Commons Bundle
 * %%
 * Copyright (C) 2013 Adobe
 * %%
 * 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.
 * #L%
 */

package com.adobe.acs.commons.quickly.results;

import org.osgi.annotation.versioning.ProviderType;
import com.google.gson.JsonObject;
import org.apache.sling.api.resource.ValueMap;

@ProviderType
@SuppressWarnings("squid:S1214")
public interface ResultSerializer {
    String PROP_TYPE = "type";

    /**
     * Turns a Result object into a JSON object
     *
     * @param result the Result
     * @param config configuration used by ResultSerializer implementations
     * @return the JSON representation of the result
     * @throws JSONException
     */
    JsonObject toJSON(Result result, ValueMap config);

}