de.ingogriebsch.spring.hateoas.siren.RepresentationModelFactories 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 org.springframework.hateoas.CollectionModel;
import org.springframework.hateoas.EntityModel;
import org.springframework.hateoas.PagedModel;
import org.springframework.hateoas.RepresentationModel;

/**
 * A container that holds the factories for all known types of {@link RepresentationModel}s that are used during the
 * deserialization process.
 * 
 * @author Ingo Griebsch
 * @since 1.0.0
 */
public interface RepresentationModelFactories {

    /**
     * The default instance that can be used if no specific implementation of this interface is necessary.
     */
    RepresentationModelFactories DEFAULT_INSTANCE = new RepresentationModelFactories() {
    };

    /**
     * @return a factory to create {@link RepresentationModel} instances.
     */
    default RepresentationModelFactory forRepresentationModel() {
        return new RepresentationModelFactory() {
        };
    }

    /**
     * @return a factory to create {@link EntityModel} instances.
     */
    default EntityModelFactory forEntityModel() {
        return new EntityModelFactory() {
        };
    }

    /**
     * @return a factory to create {@link CollectionModel} instances.
     */
    default CollectionModelFactory forCollectioModel() {
        return new CollectionModelFactory() {
        };
    }

    /**
     * @return a factory to create {@link PagedModel} instances.
     */
    default PagedModelFactory forPagedModel() {
        return new PagedModelFactory() {
        };
    }

}