io.micronaut.data.model.runtime.convert.AttributeConverter Maven / Gradle / Ivy

Go to download

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

Data Repository Support for Micronaut

The 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.convert;

import io.micronaut.core.annotation.Indexed;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.core.convert.ConversionContext;

/**
 * The attribute converter is used for converting mapped entity value to the persisted value and back.
 *
 * @param  The entity value type
 * @param  The persisted value type
 * @author Denis Stepanov
 * @since 3.1
 */
@Indexed(AttributeConverter.class)
public interface AttributeConverter {

    /**
     * Converts the entity value to the persisted value.
     *
     * @param entityValue The entity value
     * @param context     The conversion context.
     * @return the persisted value
     */
    @Nullable
    Y convertToPersistedValue(@Nullable X entityValue, @NonNull ConversionContext context);

    /**
     * Converts the persisted value to the entity value.
     *
     * @param persistedValue The persisted value
     * @param context        The conversion context.
     * @return the entity value
     */
    @Nullable
    X convertToEntityValue(@Nullable Y persistedValue, @NonNull ConversionContext context);

}