com.openpojo.business.identity.impl.DefaultBusinessValidator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openpojo Show documentation

This project was born out of a need to validate all POJOs (Plain Old Java Object) are behaving correctly. This project has two main aspects to it: * Make Testing as easy as possible. * Simplifying identity management (hashCode / equals) using annotation.

There is a newer version: 0.7.3

Show newest version

/*
 * Copyright (c) 2010-2012 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 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.business.identity.impl;

import com.openpojo.business.annotation.BusinessKey;
import com.openpojo.business.exception.BusinessException;
import com.openpojo.business.identity.BusinessValidator;
import com.openpojo.business.utils.BusinessPojoHelper;
import com.openpojo.reflection.PojoField;

/**
 * This class is the default implementation for business validation.
 * Its primary responsibility is to validate that a business POJO has the following:

 * 1. One or more {@link BusinessKey} fields defined.

 * 2. All Required/Composite fields have values where required.
 *
 * @author oshoukry
 */
public class DefaultBusinessValidator implements BusinessValidator {

    private DefaultBusinessValidator() {

    }

    public static BusinessValidator getInstance() {
        return DefaultBusinessValidator.Instance.INSTANCE;
    }

    public void validate(final Object object) {
        if (object == null) {
            return;
        }

        boolean compositeGroupPassed = false;
        boolean hasCompositeGroup = false;
        boolean hasBusinessKey = false;
        for (PojoField pojoField : BusinessPojoHelper.getBusinessKeyFields(object.getClass())) {
            final BusinessKey businessKey = pojoField.getAnnotation(BusinessKey.class);
            hasBusinessKey = true;
            if (businessKey.composite()) {
                if (pojoField.get(object) != null) {
                    compositeGroupPassed = true;
                }
                hasCompositeGroup = true;
            } else {
                if (businessKey.required() && pojoField.get(object) == null) {
                    throw BusinessException.getInstance((String.format("Field required and can't be null [%s]", pojoField)));
                }
            }
        }
        if (!hasBusinessKey) {
            throw BusinessException.getInstance(String.format("No business Keys defined on class=[%s]", object.getClass()));
        }

        if (!compositeGroupPassed && hasCompositeGroup) {
            throw BusinessException.getInstance(String.format("Non of the fields in the composite group were populated [%s]",
                    object.getClass()));
        }
    }

    private static class Instance {
        static final BusinessValidator INSTANCE = new DefaultBusinessValidator();
    }
}