org.apache.sling.scripting.sightly.Record Maven / Gradle / Ivy

/*******************************************************************************
 * 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.scripting.sightly;

import java.util.Set;

import org.osgi.annotation.versioning.ConsumerType;

/**
 * A {@code Record} is a key-value immutable object understood by the HTL runtime, used for abstracting complex objects like Sightly
 * templates (declared with the {@code data-sly-template} block element) or objects that need to be translated from Java to JavaScript
 * and back.
 *
 * @param  the type of values for this record
 */
@ConsumerType
public interface Record {

    /**
     * Gets the value of a specified property.
     *
     * @param name the name of the property
     * @return the value of the property or {@code null} if this record does not have the specified property
     */
    T getProperty(String name);

    /**
     * Gets the set of names for this record's properties.
     *
     * @return this record's properties' names
     */
    Set getPropertyNames();

}