com.openpojo.validation.utils.ValidationHelper Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2010 Osman Shoukry
 *
 *   This program 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.
 *
 *   This program 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 this program.  If not, see .
 */
package com.openpojo.validation.utils;

import com.openpojo.reflection.PojoClass;
import com.openpojo.reflection.PojoField;
import com.openpojo.reflection.construct.InstanceFactory;

/**
 * This Validation helper utility class will carry the collection of common
 * tasks performed by various validation tasks.
 *
 * @author oshoukry
 */
public final class ValidationHelper {
    /**
     * Return true if the PojoField is marked as static and is final.
     *
     * @param fieldEntry
     *            The field to test.
     * @return
     *         True if the field was declared static final, false otherwise.
     */
    public static boolean isStaticFinal(final PojoField fieldEntry) {
        return fieldEntry.isFinal() && fieldEntry.isStatic();
    }

    /**
     * This helper method is responsible for creating an instance of a PojoClass.
     * This method will favor the most basic constructor in terms of parameters.
     * 

     * Example: if you have two constructors one with no parameters and one with some parameters
     * This method will invoke the one without parameters.
     *
     * @param pojoClass
     *            The class to instantiate.
     * @return
     *         An Instance of the class.
     */
    public static Object getBasicInstance(final PojoClass pojoClass) {
        return InstanceFactory.getLeastCompleteInstance(pojoClass);
    }

    /**
     * This helper method is responsible for creating an instance of a PojoClass.
     * This method will favor the most complete constructor in terms of parameters.
     * 

     * Example: if you have two constructors one with no parameters and one with some parameters
     * This method will invoke the one with some parameters.
     *
     * @param pojoClass
     *            The class to instantiate.
     * @return
     *         An Instance of the class.
     */
    public static Object getMostCompleteInstance(final PojoClass pojoClass) {
        return InstanceFactory.getMostCompleteInstance(pojoClass);
    }
}