org.apache.logging.log4j.core.config.plugins.validation.validators.RequiredValidator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of log4j-core Show documentation

The Apache Log4j Implementation

There is a newer version: 3.0.0-beta2

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.logging.log4j.core.config.plugins.validation.validators;

import java.util.Collection;
import java.util.Map;

import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.config.plugins.validation.ConstraintValidator;
import org.apache.logging.log4j.core.config.plugins.validation.constraints.Required;
import org.apache.logging.log4j.status.StatusLogger;

/**
 * Validator that checks an object for emptiness. Emptiness is defined here as:
 * 
 * The value {@code null}
 * An object of type {@link CharSequence} with length 0
 * An empty array
 * An empty {@link Collection}
 * An empty {@link Map}
 * 
 *
 * @since 2.1
 */
public class RequiredValidator implements ConstraintValidator {

    private static final Logger LOGGER = StatusLogger.getLogger();

    private Required annotation;

    @Override
    public void initialize(final Required anAnnotation) {
        this.annotation = anAnnotation;
    }

    @Override
    public boolean isValid(final String name, final Object value) {
        if (value == null) {
            return err(name);
        }
        if (value instanceof CharSequence) {
            final CharSequence sequence = (CharSequence) value;
            return sequence.length() != 0 || err(name);
        }
        final Class clazz = value.getClass();
        if (clazz.isArray()) {
            final Object[] array = (Object[]) value;
            return array.length != 0 || err(name);
        }
        if (Collection.class.isAssignableFrom(clazz)) {
            final Collection collection = (Collection) value;
            return collection.size() != 0 || err(name);
        }
        if (Map.class.isAssignableFrom(clazz)) {
            final Map map = (Map) value;
            return map.size() != 0 || err(name);
        }
        // LOGGER.debug("Encountered type [{}] which can only be checked for null.", clazz.getName());
        return true;
    }

    private boolean err(final String name) {
        LOGGER.error(annotation.message() + ": " + name);
        return false;
    }
}