de.ingogriebsch.spring.hateoas.siren.EntityModelFactory Maven / Gradle / Ivy

Go to download
/*-
 * Copyright 2019-2020 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
 *
 *      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 de.ingogriebsch.spring.hateoas.siren;

import static de.ingogriebsch.spring.hateoas.siren.BeanUtils.applyProperties;
import static de.ingogriebsch.spring.hateoas.siren.BeanUtils.instantiate;
import static org.springframework.util.Assert.isAssignable;

import java.util.Map;

import com.fasterxml.jackson.databind.JavaType;
import lombok.NonNull;
import org.springframework.hateoas.EntityModel;
import org.springframework.hateoas.Link;
import org.springframework.lang.Nullable;

/**
 * A factory to create an {@link EntityModel} instance based on the given input that is evaluated during deserialization.
 * 
 * @author Ingo Griebsch
 * @since 1.0.0
 * @see EntityModel
 */
public interface EntityModelFactory {

    /**
     * Creates an {@link EntityModel} based on the given input.
     * 
     * The default implementation instantiates the concrete {@link EntityModel} based on the assumption that the
     * {@link EntityModel#EntityModel(Object, Iterable)} constructor is accessible.
     * 
     * @param type the type of the instance that should be created. Must be assignable to {@link EntityModel}. Is never
     *        {@literal null}.
     * @param links the links which should be used to instantiate the {@link EntityModel model}. Is never {@literal null}.
     * @param content the object which should be used to instantiate the {@link EntityModel model}. Is never {@literal null}.
     * @param properties the properties which should be applied on the instantiated {@link EntityModel model}. Can be
     *        {@literal null}.
     * @return the created {@link EntityModel} instance.
     */
    default EntityModel create(@NonNull JavaType type, @NonNull Iterable links, @NonNull Object content,
        @Nullable Map properties) {
        Class modelType = type.getRawClass();
        isAssignable(EntityModel.class, modelType);

        // TODO Check if the type of the content object matches the contained type of the given type.

        Class[] types =
            new Class[] { EntityModel.class.equals(modelType) ? Object.class : content.getClass(), Iterable.class };
        Object[] args = new Object[] { content, links };
        EntityModel model = (EntityModel) instantiate(modelType, types, args);

        if (properties != null) {
            applyProperties(model, properties);
        }
        return model;
    }
}