PreferenceVO.java

/*
 * Copyright 2005-2025 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
 *
 * http://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 org.openwms.core.preferences.api;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.Size;
import org.ameba.http.AbstractBase;

import java.io.Serializable;
import java.util.Objects;

/**
 * A PreferenceVO.
 *
 * @author Heiko Scherrer
 */
@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS)
public class PreferenceVO extends AbstractBase<PreferenceVO> {

    public static final String TYPE = "application";
    public static final String SUB_TYPE = "vnd.openwms.core.preference-v1+json";
    /** HTTP media type representation. */
    public static final String MEDIA_TYPE = TYPE + "/" + SUB_TYPE;

    /** The persistent key of the resource. */
    @JsonProperty("pKey")
    private String pKey;

    /** The unique business key (along other identifying properties) of the resource, must not be {@literal null}. */
    @JsonProperty("key")
    @NotBlank
    @Size(min = 1, max = PreferencesConstants.LENGTH_KEY)
    private String key;

    /** The owner of the resource. */
    @JsonProperty("owner")
    @Size(max = PreferencesConstants.LENGTH_OWNER)
    private String owner;

    /** A descriptive text of the {@code Preference}. */
    @JsonProperty("description")
    @Size(max = PreferencesConstants.LENGTH_DESCRIPTION)
    private String description;

    /** The value of the {@code Preference}. */
    @JsonProperty("value")
    @Size(max = PreferencesConstants.LENGTH_VALUE)
    private Serializable val;

    /** The groupName of the {@code Preference}. */
    @JsonProperty("groupName")
    @Size(max = PreferencesConstants.LENGTH_GROUP)
    private String groupName;

    /** The type of the {@code Preference}. */
    @JsonProperty("type")
    @NotBlank
    @Size(max = PreferencesConstants.LENGTH_TYPE)
    private String type;

    public String getpKey() {
        return pKey;
    }

    @JsonIgnore
    public boolean hasPKey() {
        return this.pKey != null && !this.pKey.isEmpty();
    }

    public void setpKey(String pKey) {
        this.pKey = pKey;
    }

    public String getKey() {
        return key;
    }

    public void setKey(String key) {
        this.key = key;
    }

    public String getOwner() {
        return owner;
    }

    public void setOwner(String owner) {
        this.owner = owner;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public Serializable getVal() {
        return val;
    }

    public void setVal(Serializable val) {
        this.val = val;
    }

    public String getGroupName() {
        return groupName;
    }

    public void setGroupName(String groupName) {
        this.groupName = groupName;
    }

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    /**
     * {@inheritDoc}
     *
     * All fields.
     */
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        if (!super.equals(o)) return false;
        PreferenceVO that = (PreferenceVO) o;
        return Objects.equals(pKey, that.pKey) &&
                Objects.equals(key, that.key) &&
                Objects.equals(owner, that.owner) &&
                Objects.equals(description, that.description) &&
                Objects.equals(val, that.val) &&
                Objects.equals(groupName, that.groupName) &&
                Objects.equals(type, that.type);
    }

    /**
     * {@inheritDoc}
     *
     * All fields.
     */
    @Override
    public int hashCode() {
        return Objects.hash(super.hashCode(), pKey, key, owner, description, val, groupName, type);
    }

    /**
     * Returns the representation type of the Preference.
     *
     * @return Conforms to the HTTP {@literal Content-Type} convention
     */
    @JsonIgnore
    public String getContentType() {
        return MEDIA_TYPE;
    }
}