net.sf.dynamicreports.report.base.DRMargin Maven / Gradle / Ivy

/*
 * DynamicReports - Free Java reporting library for creating reports dynamically
 *
 * Copyright (C) 2010 - 2018 Ricardo Mariaca and the Dynamic Reports Contributors
 *
 * This file is part of DynamicReports.
 *
 * DynamicReports is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * DynamicReports is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with DynamicReports. If not, see .
 */
package net.sf.dynamicreports.report.base;

import net.sf.dynamicreports.report.constant.Constants;
import net.sf.dynamicreports.report.definition.DRIMargin;
import org.apache.commons.lang3.Validate;

/**
 * DRMargin class.
 *
 * @author Ricardo Mariaca
 * 
 */
public class DRMargin implements DRIMargin {
    private static final long serialVersionUID = Constants.SERIAL_VERSION_UID;

    private int top;
    private int left;
    private int bottom;
    private int right;

    /**
     * Constructor for DRMargin.
     */
    public DRMargin() {
    }

    /**
     * Constructor for DRMargin.
     *
     * @param margin a int.
     */
    public DRMargin(int margin) {
        Validate.isTrue(margin >= 0, "margin must be >= 0");
        top = margin;
        left = margin;
        bottom = margin;
        right = margin;
    }

    /** {@inheritDoc} */
    @Override
    public int getTop() {
        return top;
    }

    /**
     * Setter for the field top.
     *
     * @param top a int.
     */
    public void setTop(int top) {
        Validate.isTrue(top >= 0, "top must be >= 0");
        this.top = top;
    }

    /** {@inheritDoc} */
    @Override
    public int getLeft() {
        return left;
    }

    /**
     * Setter for the field left.
     *
     * @param left a int.
     */
    public void setLeft(int left) {
        Validate.isTrue(left >= 0, "left must be >= 0");
        this.left = left;
    }

    /** {@inheritDoc} */
    @Override
    public int getBottom() {
        return bottom;
    }

    /**
     * Setter for the field bottom.
     *
     * @param bottom a int.
     */
    public void setBottom(int bottom) {
        Validate.isTrue(bottom >= 0, "bottom must be >= 0");
        this.bottom = bottom;
    }

    /** {@inheritDoc} */
    @Override
    public int getRight() {
        return right;
    }

    /**
     * Setter for the field right.
     *
     * @param right a int.
     */
    public void setRight(int right) {
        Validate.isTrue(right >= 0, "right must be >= 0");
        this.right = right;
    }
}