Package de.ingogriebsch.spring.hateoas.siren

Interface CollectionModelFactory

  • public interface CollectionModelFactory
    A factory to create a CollectionModel instance based on the given input that is evaluated during deserialization.
    Since:
    1.0.0
    Author:
    Ingo Griebsch
    See Also:
    CollectionModel

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default org.springframework.hateoas.CollectionModel<?> create​(@NonNull com.fasterxml.jackson.databind.JavaType type, @NonNull Iterable<org.springframework.hateoas.Link> links, @NonNull Iterable<Object> content, Map<String,​Object> properties)
      Creates a CollectionModel based on the given input.

    • Method Detail

      • create

        default org.springframework.hateoas.CollectionModel<?> create​(@NonNull
                                                              @NonNull com.fasterxml.jackson.databind.JavaType type,
                                                              @NonNull
                                                              @NonNull Iterable<org.springframework.hateoas.Link> links,
                                                              @NonNull
                                                              @NonNull Iterable<Object> content,
                                                              @Nullable
                                                              Map<String,​Object> properties)
        Creates a CollectionModel based on the given input.

        The default implementation instantiates the concrete CollectionModel based on the assumption that the CollectionModel(Iterable, Iterable) constructor is accessible.

        Parameters:
        type - the type of the instance that should be created. Must be assignable to CollectionModel. Is never null.
        links - the links which should be used to instantiate the model. Is never null.
        content - the objects which should be used to instantiate the model. Is never null.
        properties - the properties which should be applied on the instantiated model. Can be null.
        Returns:
        the created CollectionModel instance.