no.hasmac.jsonld.lang.ListObject Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hasmac-json-ld Show documentation
A more performant JSON-LD 1.1 Processor & API forked from Titanium JSON-LD.
The newest version!
/*
 * Copyright 2020 APICATALOG and HASMAC.
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package no.hasmac.jsonld.lang;

import jakarta.json.JsonObject;
import jakarta.json.JsonValue;
import no.hasmac.jsonld.json.JsonProvider;
import no.hasmac.jsonld.json.JsonUtils;

public final class ListObject {

    private ListObject() {
    }

    /**
     * A list object is a map that has a @list key. It may also have
     * an @index key, but no other entries. See the Lists and Sets section of
     * JSON-LD 1.1 for a normative description.
     *
     * @see List
     *      Object
     *
     * @param value to check
     * @return true if the provided value is valid list object
     */
    public static boolean isListObject(JsonValue value) {
        return JsonUtils.containsKey(value, Keywords.LIST)
                    && (value.asJsonObject().size() == 1
                            || (value.asJsonObject().size() == 2
                                    && value.asJsonObject().containsKey(Keywords.INDEX)
                                    )
                            );
    }

    /**
     * Convert expanded value to a list object by first setting it to an array
     * containing only expanded value if it is not already an array, and then by
     * setting it to a map containing the key-value pair @list-expanded value.
     *
     * @param value to convert
     * @return list object containing the provided value
     */
    public static JsonObject toListObject(JsonValue value) {
        if (JsonUtils.isArray(value)) {
            return JsonProvider.instance().createObjectBuilder().add(Keywords.LIST, value).build();
        }

        return JsonProvider.instance().createObjectBuilder().add(Keywords.LIST, JsonProvider.instance().createArrayBuilder().add(value)).build();

    }
}