org.apache.sling.validation.model.ResourceProperty Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.apache.sling.validation.api Show documentation

The Apache Sling Validation Framework API

The newest version!

/*
 * 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.validation.model;

import java.util.List;
import java.util.regex.Pattern;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.osgi.annotation.versioning.ProviderType;

/**
 * Describes a {@link org.apache.sling.api.resource.Resource} property.
 */
@ProviderType
public interface ResourceProperty {

    /**
     * Returns the name of this property. This must match the name of the property which is validated through this section of the validation model.
     * In case {@link #getNamePattern()} is not {@code null} this name is not relevant for matching the property.
     *
     * @return the name
     */
    @NotNull
    String getName();

    /**
     * Returns the name pattern for this property. In case this is not returning {@code null}, this pattern is used for finding the properties which should be validated.
     *
     * @return the name pattern (if one is set) or {@code null}
     */
    @Nullable
    Pattern getNamePattern();

    /**
     *
     * @return {@code true} if the property is expected to contain multiple values, {@code false} otherwise
     */
    boolean isMultiple();

    /**
     * Returns {@code true} if at least one property matching the name/namePattern is required.
     *
     * @return {@code true} if the property is required, {@code false} otherwise
     */
    boolean isRequired();

    /**
     * Returns a list of {@link ValidatorInvocation}s which should be applied on this property.
     *
     * @return the {@link List} of {@link ValidatorInvocation}s
     */
    @NotNull
    List getValidatorInvocations();
}