com.thesett.aima.attribute.validation.ValidEnumValidator Maven / Gradle / Ivy

Go to download

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

Power model provides the ability to reflect and navigate on Java data models. It also provides some useful data types that can be used in data modelling.

There is a newer version: 0.9.117

Show newest version

/*
 * Copyright The Sett Ltd, 2005 to 2014.
 *
 * 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.
 */
package com.thesett.aima.attribute.validation;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

import com.thesett.aima.attribute.impl.EnumeratedStringAttribute;

/**
 * ValidEnumValidator checks that a value contains a valid instance of an
 * {@link com.thesett.aima.attribute.impl.EnumeratedStringAttribute}. To be considered valid, the value must have an id
 * on it, that is not -1. null values are also considered to be valid, as null checking can be handled
 * by other validations.
 *
 * 
 * 
 * 
 * CRC Card Responsibilities  Collaborations 
 Check that an instance of an enum has a valid id. 
 */
public class ValidEnumValidator implements ConstraintValidator
{
    /** The name of the enumeration type the the value must be a valid instance of. */
    private String enumTypeName;

    /** {@inheritDoc} */
    public void initialize(ValidEnum constraintAnnotation)
    {
        this.enumTypeName = constraintAnnotation.value();
    }

    /** {@inheritDoc} */
    public boolean isValid(EnumeratedStringAttribute value, ConstraintValidatorContext context)
    {
        if (value == null)
        {
            return true;
        }

        return value.getId() != -1;
    }
}