de.ingogriebsch.spring.hateoas.siren.SirenModel 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 lombok.AccessLevel.PRIVATE;

import java.util.List;

import lombok.AllArgsConstructor;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.NonNull;
import lombok.ToString;
import lombok.experimental.FieldDefaults;
import org.springframework.hateoas.LinkRelation;
import org.springframework.hateoas.RepresentationModel;

/**
 * A {@link RepresentationModel} extension which helps to build complex Siren entity structures.
 * 
 * @author Ingo Griebsch
 * @since 1.0.0
 * @see RepresentationModel
 * @see Siren Entity
 */
@AllArgsConstructor
@EqualsAndHashCode(callSuper = true)
@FieldDefaults(makeFinal = false, level = PRIVATE)
@Getter
@NoArgsConstructor
@ToString
class SirenModel extends RepresentationModel {

    Object properties;
    List entities;
    List classes;
    String title;

    /**
     * Represents an embedded representation.
     * 
     * @author Ingo Griebsch
     */
    @AllArgsConstructor
    @EqualsAndHashCode
    @FieldDefaults(makeFinal = false, level = PRIVATE)
    @Getter
    @NoArgsConstructor
    @ToString
    static class EmbeddedRepresentation {

        @NonNull
        RepresentationModel model;
        List rels;

        EmbeddedRepresentation(RepresentationModel model) {
            this.model = model;
        }

        EmbeddedRepresentation(RepresentationModel model, String rel) {
            this(model, LinkRelation.of(rel));
        }

        EmbeddedRepresentation(RepresentationModel model, LinkRelation rel) {
            this(model, newArrayList(rel));
        }
    }
}