io.neba.api.spi.ResourceModelFactory 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.spi;

import io.neba.api.annotations.ResourceModel;

import javax.annotation.Nonnull;
import java.util.Collection;

/**
 * Represents a source for resource models. NEBA will register all services of this type to obtain the available resource models. The models
 * will be tied to the scope of the providing service.
 *
 * @author Olaf Otto
 * @since 5.0.0
 */
public interface ResourceModelFactory {
    /**
     * @return A list of all {@link ModelDefinition model definitions} suitable for {@link #getModel(ModelDefinition) model} resolution.
     * Never null but rather an empty collection.
     */
    @Nonnull
    Collection getModelDefinitions();

    /**
     * @param modelDefinition must not be null.
     * @return an instance of the model with the given name. Never null.
     */
    @Nonnull
    Object getModel(@Nonnull ModelDefinition modelDefinition);

    /**
     * @author Olaf Otto
     */
    interface ModelDefinition {
        @Nonnull
        ResourceModel getResourceModel();

        /**
         * The unique name of a model. This name may be used for model resolution by name
         * and will be displayed in the model registry console.
         */
        @Nonnull
        String getName();

        /**
         * The type which is {@link Class#isAssignableFrom(Class) assignment-compatible} with the model implementation class. For instance,
         * the actual model class or an interface the model implements.
         */
        @Nonnull
        Class getType();
    }
}