net.nemerosa.ontrack.ui.resource.Resource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ontrack-ui-support Show documentation

Ontrack module: ontrack-ui-support

There is a newer version: 4.4.5

package net.nemerosa.ontrack.ui.resource;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonUnwrapped;
import lombok.Data;
import lombok.EqualsAndHashCode;
import net.nemerosa.ontrack.model.structure.ViewSupplier;
import org.apache.commons.lang3.Validate;

import java.beans.ConstructorProperties;
import java.net.URI;

/**
 * The resource wrapper class might be used for UI return types whenever:
 * 
 * a model object is not applicable, when describing an API for example
 * the links cannot be derived from the model object because the resource
 * maybe served by different controllers
 * 
 *
 * @param  Type of data to wrap into the resource
 */
@EqualsAndHashCode(callSuper = false)
@Data
@JsonPropertyOrder(alphabetic = true)
public class Resource extends LinkContainer> implements ViewSupplier {

    @JsonUnwrapped
    private final T data;
    @JsonIgnore
    private final Class viewType;

    @ConstructorProperties({"data", "_self"})
    protected Resource(T data, URI self) {
        this(data, self, data.getClass());
    }

    private Resource(T data, URI self, Class view) {
        super(self);
        Validate.notNull(data, "Null data is not acceptable for a resource");
        this.data = data;
        this.viewType = view;
    }

    public static  Resource of(R data, URI self) {
        return new Resource<>(data, self);
    }

    public Resource withView(Class view) {
        return new Resource<>(data, get_self(), view);
    }

}