fr.landel.utils.assertor.commons.ParameterAssertor Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * utils-assertor
 * %%
 * Copyright (C) 2016 - 2018 Gilles Landel
 * %%
 * 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.
 * #L%
 */
package fr.landel.utils.assertor.commons;

import java.io.Serializable;

import fr.landel.utils.assertor.enums.EnumType;
import fr.landel.utils.commons.builder.ToStringBuilder;
import fr.landel.utils.commons.builder.ToStringStyles;

/**
 * Assertor parameter DTO
 *
 * @since Feb 4, 2017
 * @author Gilles
 *
 * @param 
 *            the type of object
 */
public class ParameterAssertor implements Serializable {

    /**
     * serialVersionUID
     */
    private static final long serialVersionUID = 1L;

    private final T object;
    private final EnumType type;
    private final boolean checked;

    /**
     * Constructor (for parameter under validation)
     *
     * @param object
     *            The object
     * @param type
     *            The type of object
     * @param checked
     *            if the object is checked
     */
    public ParameterAssertor(final T object, final EnumType type, final boolean checked) {
        this.object = object;
        this.type = type;
        this.checked = checked;
    }

    /**
     * Constructor (for parameter used to check)
     *
     * @param object
     *            The object
     * @param type
     *            The type of object
     */
    public ParameterAssertor(final T object, final EnumType type) {
        this(object, type, false);
    }

    /**
     * Constructor (for parameter used to check)
     *
     * @param object
     *            The object
     */
    public ParameterAssertor(final T object) {
        this(object, EnumType.getType(object), false);
    }

    /**
     * @return the object
     */
    public T getObject() {
        return this.object;
    }

    /**
     * @return the type
     */
    public EnumType getType() {
        return this.type;
    }

    /**
     * @return the checked
     */
    public boolean isChecked() {
        return this.checked;
    }

    @Override
    public String toString() {
        // @formatter:off
        return new ToStringBuilder(this, ToStringStyles.JSON_SPACED)
                .append("object", this.object)
                .append("type", this.type)
                .append("checked", this.checked)
                .build();
        // @formatter:on
    }
}