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

/**
 * Utility methods help to deal with different use cases related to all types of {@link RepresentationModel}.
 * 
 * @author Ingo Griebsch
 * @since 1.0.0
 */
@NoArgsConstructor(access = PRIVATE)
class RepresentationModelUtils {

    // Order on purpose!
    private static final List> REPRESENTATION_MODEL_TYPES =
        newArrayList(PagedModel.class, CollectionModel.class, EntityModel.class, RepresentationModel.class);

    static boolean isRepresentationModel(Class clazz) {
        for (Class resourceType : REPRESENTATION_MODEL_TYPES) {
            if (resourceType.isAssignableFrom(clazz)) {
                return true;
            }
        }
        return false;
    }

    static boolean isRepresentationModelSubclass(Class clazz) {
        return !REPRESENTATION_MODEL_TYPES.contains(clazz) && REPRESENTATION_MODEL_TYPES.contains(clazz.getSuperclass());
    }

    @SuppressWarnings("unchecked")
    static Class> getRepresentationModelClass(Class clazz) {
        for (Class resourceType : REPRESENTATION_MODEL_TYPES) {
            if (resourceType.isAssignableFrom(clazz)) {
                return (Class>) resourceType;
            }
        }
        return null;
    }

    static RepresentationModel wrap(Object obj) {
        if (isRepresentationModelSubclass(obj.getClass())) {
            return (RepresentationModel) obj;
        }

        return RepresentationModel.of(obj);
    }
}