package mypackage.bean.hal;

import mypackage.bean.ImmutableStyle;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonUnwrapped;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import io.swagger.annotations.ApiModel;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import org.immutables.value.Value;

/**
 * The HateoasBean contains another Jackson-serializable bean plus links to other resources.
 *
 * It's done like this to not pollute all the JSON beans with _links entries.
 */
@ApiModel(value = "HALBean", description = "Root bean of all return values")
@Value.Immutable
@ImmutableStyle
@JsonSerialize(as = ImmutableHalBean.class)
@JsonDeserialize(as = ImmutableHalBean.class)
public interface HalBean<T> {

  @JsonUnwrapped
  Optional<T> getBean();

  @JsonProperty("_links")
  Optional<Links> getLinks();

  @JsonProperty("_embedded")
  Map<String, List<HalBean<T>>> getEmbedded();

  static <T> HalBean<T> of(final T bean, final Links links) {
    return ImmutableHalBean.<T>builder().setBean(bean).setLinks(links).build();
  }

  static <T> HalBean<T> of(final Links links) {
    return ImmutableHalBean.<T>builder().setLinks(links).build();
  }
}