StackingRuleVO.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.wms.inventory.api;

import com.fasterxml.jackson.annotation.JsonBackReference;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import jakarta.validation.constraints.NotNull;

import java.beans.ConstructorProperties;
import java.util.Objects;

/**
 * A StackingRuleVO.
 *
 * @author Heiko Scherrer
 */
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class StackingRuleVO {

    /** Parent {@code Product} (not-null). */
    @JsonBackReference
    public ProductVO product;

    /** Number of units the {@code allowedProduct} can be stacked on the owning {@code baseProduct} (not-null). */
    @JsonProperty("noProducts")
    @NotNull
    private Integer noProducts;

    /** The allowed {@code Product} that may be placed on the owning {@code Product} (not-null). */
    @JsonProperty("allowedProduct")
    @NotNull
    private ProductVO allowedProduct;

    /*~ -------------- Constructors -------------- */
    /* For the Mapper */
    public StackingRuleVO() {
    }

    @ConstructorProperties({"noProducts", "allowedProduct"})
    public StackingRuleVO(Integer noProducts, ProductVO allowedProduct) {
        this.noProducts = noProducts;
        this.allowedProduct = allowedProduct;
    }

    /*~ --------------- Accessors ---------------- */
    public ProductVO getProduct() {
        return product;
    }

    public void setProduct(ProductVO product) {
        this.product = product;
    }

    public Integer getNoProducts() {
        return noProducts;
    }

    public void setNoProducts(Integer noProducts) {
        this.noProducts = noProducts;
    }

    public ProductVO getAllowedProduct() {
        return allowedProduct;
    }

    public void setAllowedProduct(ProductVO allowedProduct) {
        this.allowedProduct = allowedProduct;
    }

    /*~ --------------- Methods ---------------- */
    @Override
    public String toString() {
        return "StackingRuleVO{" +
                "product=" + product +
                ", noProducts=" + noProducts +
                ", allowedProduct=" + allowedProduct +
                '}';
    }

    /**
     * {@inheritDoc}
     *
     * All fields.
     */
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof StackingRuleVO)) return false;
        StackingRuleVO that = (StackingRuleVO) o;
        return Objects.equals(product, that.product) && Objects.equals(noProducts, that.noProducts) && Objects.equals(allowedProduct, that.allowedProduct);
    }

    /**
     * {@inheritDoc}
     *
     * All fields.
     */
    @Override
    public int hashCode() {
        return Objects.hash(product, noProducts, allowedProduct);
    }
}