io.micronaut.data.processor.model.criteria.SourcePersistentEntityCriteriaUpdate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-data-processor Show documentation

Data Repository Support for Micronaut

There is a newer version: 4.9.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.processor.model.criteria;

import io.micronaut.core.annotation.Experimental;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.data.model.jpa.criteria.PersistentEntityCriteriaUpdate;
import io.micronaut.data.model.jpa.criteria.PersistentEntityRoot;
import io.micronaut.inject.ast.ClassElement;

/**
 * The source persistent entity extension of {@link PersistentEntityCriteriaUpdate}.
 *
 * @param  The entity type
 * @author Denis Stepanov
 * @since 3.2
 */
@Experimental
public interface SourcePersistentEntityCriteriaUpdate extends PersistentEntityCriteriaUpdate {

    /**
     * Creates a {@link PersistentEntityRoot} from class element representing the entity.
     *
     * @param entityClassElement The entity class element
     * @param  The root type
     * @return new root
     */
    @NonNull
     PersistentEntityRoot from(@NonNull ClassElement entityClassElement);

    /**
     * @return The query result type name
     * @since 4.2.0
     */
    @Nullable
    String getQueryResultTypeName();
}