All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.micronaut.data.model.runtime.RuntimeEntityRegistry Maven / Gradle / Ivy

There is a newer version: 4.10.3
Show newest version
/*
 * Copyright 2017-2021 original 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
 *
 * https://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.micronaut.data.model.runtime;

import io.micronaut.context.ApplicationContextProvider;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.core.annotation.Experimental;
import io.micronaut.data.event.EntityEventListener;

/**
 * A registry for looking up entities across repositories.
 *
 * @author graemerocher
 * @since 2.3.0
 */
public interface RuntimeEntityRegistry extends ApplicationContextProvider {
    /**
     * @return The primary entity event listener
     */
    @NonNull EntityEventListener getEntityEventListener();

    /**
     * @param persistentProperty The persistent property
     * @param previousValue The previous value
     * @return The new value, never null.
     */
    @Experimental
    @NonNull Object autoPopulateRuntimeProperty(
            @NonNull RuntimePersistentProperty persistentProperty,
            @Nullable Object previousValue
    );

    /**
     * Get a new, non-cached instance.
     * @param type The type
     * @param  The generic type
     * @return The entity
     */
    @NonNull  RuntimePersistentEntity getEntity(@NonNull Class type);

    /**
     * Get a new, non-cached instance.
     * @param type The type
     * @param  The generic type
     * @return The entity
     */
    @NonNull  RuntimePersistentEntity newEntity(@NonNull Class type);
}