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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-hateoas-siren Show documentation

A library implementing Siren as a custom Spring HATEOAS hypermedia type. Siren is a hypermedia specification for representing entities.

The newest version!

/*-
 * 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 com.google.common.collect.Lists.newArrayList;
import static com.google.common.collect.Maps.newHashMap;
import static de.ingogriebsch.spring.hateoas.siren.SirenNavigables.navigables;
import static lombok.AccessLevel.PRIVATE;

import java.util.List;
import java.util.Map;

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

/**
 * Builder that helps the {@link SirenEntityModelDeserializer} to deserialize a Siren entity into a {@link EntityModel}.
 * 
 * @author Ingo Griebsch
 * @since 1.0.0
 * @see EntityModel
 */
@RequiredArgsConstructor(access = PRIVATE)
class SirenEntityModelBuilder {

    private final JavaType type;
    private final EntityModelFactory modelFactory;
    private final SirenLinkConverter linkConverter;

    private Map properties = newHashMap();
    private List actions = newArrayList();
    private List links = newArrayList();
    private Object content;

    static SirenEntityModelBuilder builder(JavaType type, EntityModelFactory modelFactory, SirenLinkConverter linkConverter) {
        return new SirenEntityModelBuilder(type, modelFactory, linkConverter);
    }

    SirenEntityModelBuilder properties(Map properties) {
        this.properties = properties;
        return this;
    }

    SirenEntityModelBuilder content(Object content) {
        this.content = content;
        return this;
    }

    SirenEntityModelBuilder links(@Nullable List links) {
        this.links = links != null ? links : newArrayList();
        return this;
    }

    SirenEntityModelBuilder actions(@Nullable List actions) {
        this.actions = actions != null ? actions : newArrayList();
        return this;
    }

    EntityModel build() {
        return modelFactory.create(type, links(), content, properties);
    }

    private Iterable links() {
        return linkConverter.from(navigables(links, actions));
    }

}