src/main/java/org/apache/sling/models/annotations/ExternalizePathProvider.java

/*
 * 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.models.annotations;

import org.jetbrains.annotations.NotNull;

/**
 * Interface for a Provider of an Externalized Path. The
 * Externalize Path Injector is selecting the Provider with
 * the highest Service Ranking so adjust the ranking as needed.
 */
public interface ExternalizePathProvider {

    /**
     * Externalizes a given Path
     * @param sourcePath The path to be externalized. If this value is null then null is returned
     * @param annotation Externalize Path Annotation of that property
     * @param adaptable The adaptable source
     * @return The externalized path if there is a mapping or otherwise the same
     */
    String externalize(@NotNull Object adaptable, ExternalizePath annotation, String sourcePath);
}