de.ingogriebsch.spring.hateoas.siren.SirenAction Maven / Gradle / Ivy

Go to download
/*-
 * 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.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL;
import static org.springframework.hateoas.mediatype.html.HtmlInputType.TEXT_VALUE;
import static org.springframework.http.HttpMethod.GET;

import java.util.List;
import java.util.stream.Stream;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import lombok.Builder;
import lombok.Builder.Default;
import lombok.NonNull;
import lombok.Singular;
import lombok.Value;
import org.springframework.context.MessageSourceResolvable;
import org.springframework.http.HttpMethod;

/**
 * Representation of a Siren action.
 *
 * @author Ingo Griebsch
 * @since 1.0.0
 * @see Siren Action
 */
@Builder
@JsonPropertyOrder({ "name", "class", "method", "href", "title", "type", "fields" })
@Value
class SirenAction {

    @NonNull
    String name;

    @JsonInclude(NON_EMPTY)
    @JsonProperty("class")
    List classes;

    @Default
    @NonNull
    HttpMethod method = GET;

    @NonNull
    String href;

    @JsonInclude(NON_NULL)
    String title;

    @JsonInclude(NON_NULL)
    String type;

    @JsonInclude(NON_EMPTY)
    @Singular
    List fields;

    @Builder
    @JsonPropertyOrder({ "name", "class", "type", "value", "title" })
    @Value
    static class Field {

        @NonNull
        private String name;

        @JsonInclude(NON_EMPTY)
        @JsonProperty("class")
        List classes;

        @Default
        @JsonInclude(NON_NULL)
        String type = TEXT_VALUE;

        @JsonInclude(NON_NULL)
        Object value;

        @JsonInclude(NON_NULL)
        String title;

        @Value(staticConstructor = "of")
        static class TitleResolvable implements MessageSourceResolvable {

            @NonNull
            String name;

            @Override
            public String[] getCodes() {
                return Stream.of(name, "default").map(it -> String.format("_field.%s.title", it)).toArray(String[]::new);
            }
        }
    }

    @Value(staticConstructor = "of")
    static class TitleResolvable implements MessageSourceResolvable {

        @NonNull
        String name;

        @Override
        public String[] getCodes() {
            return Stream.of(name, "default").map(it -> String.format("_action.%s.title", it)).toArray(String[]::new);
        }
    }
}