io.neba.api.services.ResourceModelResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of io.neba.neba-api Show documentation

Contains all annotations, tag libraries and lifecycle callback interfaces of NEBA. All packages of this API bundle are exported. Change to the API that are not byte code compatible only occur in major revisions.

There is a newer version: 5.2.3

Show newest version

/*
  Copyright 2013 the original author or authors.

  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.
*/
package io.neba.api.services;

import org.apache.sling.api.resource.Resource;

import javax.annotation.CheckForNull;

/**
 * This service is automatically published by the NEBA core and allows programmatic lookup of resource models.
 *
 * @since 5.0.0
 * @author Olaf Otto
 */
public interface ResourceModelResolver {
    /**
     * @param resource must not be null
     * @param name must not be null
     * @return the most specific model instance compatible with the
     * given resource's resource type, or null. The
     * model's {@link io.neba.api.spi.ResourceModelFactory.ModelDefinition#getName() name} matches the given name.
     */
    @CheckForNull
    Object resolveMostSpecificModelWithName(Resource resource, String name);

    /**
     * @param resource must not be null.
     * @return the most specific model for the given resource, or null if
     * there is no unique most specific model. Models for base types such as nt:usntructured
     * or nt:base are not considered.
     */
    @CheckForNull
    Object resolveMostSpecificModel(Resource resource);

    /**
     * @param resource must not be null.
     * @return the most specific model for the given resource, or null if
     * there is no unique most specific model. Models for base types such as nt:unstructured
     * or nt:base are considered.
     */
    @CheckForNull
    Object resolveMostSpecificModelIncludingModelsForBaseTypes(Resource resource);
}