com.openpojo.validation.rule.impl.BusinessKeyMustExistRule 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-2013 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.validation.rule.impl;

import com.openpojo.business.annotation.BusinessKey;
import com.openpojo.business.utils.BusinessPojoHelper;
import com.openpojo.reflection.PojoClass;
import com.openpojo.reflection.PojoField;
import com.openpojo.validation.affirm.Affirm;
import com.openpojo.validation.rule.Rule;

/**
 * This rule ensures that PojoClass declares at least one required {@link BusinessKey}.

 * Required BusinessKey means either the required = true, or composite = true.
 *
 * @author oshoukry
 */
public class BusinessKeyMustExistRule implements Rule {

    public void evaluate(final PojoClass pojoClass) {
        for (PojoField pojoField : BusinessPojoHelper.getBusinessKeyFields(pojoClass.getClazz())) {
            BusinessKey businessKey = pojoField.getAnnotation(BusinessKey.class);
            if (businessKey.required() || businessKey.composite()) {
                return;
            }
        }

        Affirm.fail(String.format("[%s] doesn't declare any 'required' BusinessKeys!!", pojoClass.getClazz()));
    }
}