org.sonar.api.config.PropertyDefinition.java Source code

Introduction

Here is the source code for org.sonar.api.config.PropertyDefinition.java

Source

/*
 * Sonar, open source software quality management tool.
 * Copyright (C) 2008-2012 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * Sonar 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.
 *
 * Sonar 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 Sonar; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.api.config;

import com.google.common.collect.ImmutableList;
import org.apache.commons.lang.ArrayUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.math.NumberUtils;
import org.sonar.api.Property;
import org.sonar.api.PropertyType;

import javax.annotation.Nullable;

import java.util.List;

/**
 * @since 3.0
 */
public final class PropertyDefinition {

    public static final class Result {
        private static final Result SUCCESS = new Result(null);

        private String errorKey = null;

        private static Result newError(String key) {
            return new Result(key);
        }

        @Nullable
        private Result(@Nullable String errorKey) {
            this.errorKey = errorKey;
        }

        public boolean isValid() {
            return StringUtils.isBlank(errorKey);
        }

        @Nullable
        public String getErrorKey() {
            return errorKey;
        }
    }

    private final String key;
    private final String defaultValue;
    private final String name;
    private final PropertyType type;
    private final String[] options;
    private final String description;
    private final String category;
    private final boolean onProject;
    private final boolean onModule;
    private final boolean isGlobal;
    private final boolean multiValues;
    private final String propertySetKey;
    private final String deprecatedKey;
    private final List<PropertyFieldDefinition> fields;

    private PropertyDefinition(Property annotation) {
        this.key = annotation.key();
        this.name = annotation.name();
        this.defaultValue = annotation.defaultValue();
        this.description = annotation.description();
        this.isGlobal = annotation.global();
        this.onProject = annotation.project();
        this.onModule = annotation.module();
        this.category = annotation.category();
        this.type = fixType(annotation.key(), annotation.type());
        this.options = annotation.options();
        this.multiValues = annotation.multiValues();
        this.propertySetKey = annotation.propertySetKey();
        this.fields = ImmutableList.copyOf(PropertyFieldDefinition.create(annotation.fields()));
        this.deprecatedKey = annotation.deprecatedKey();
    }

    private PropertyDefinition(String key, PropertyType type, String[] options) {
        this.key = key;
        this.name = null;
        this.defaultValue = null;
        this.description = null;
        this.isGlobal = true;
        this.onProject = false;
        this.onModule = false;
        this.category = null;
        this.type = type;
        this.options = options;
        this.multiValues = false;
        this.propertySetKey = null;
        this.fields = null;
        this.deprecatedKey = null;
    }

    private static PropertyType fixType(String key, PropertyType type) {
        // Auto-detect passwords and licenses for old versions of plugins that
        // do not declare property types
        if (type == PropertyType.STRING) {
            if (StringUtils.endsWith(key, ".password.secured")) {
                return PropertyType.PASSWORD;
            } else if (StringUtils.endsWith(key, ".license.secured")) {
                return PropertyType.LICENSE;
            }
        }
        return type;
    }

    public static PropertyDefinition create(Property annotation) {
        return new PropertyDefinition(annotation);
    }

    public static PropertyDefinition create(String key, PropertyType type, String[] options) {
        return new PropertyDefinition(key, type, options);
    }

    public Result validate(@Nullable String value) {
        return validate(type, value, options);
    }

    static Result validate(PropertyType type, @Nullable String value, String[] options) {
        if (StringUtils.isNotBlank(value)) {
            if (type == PropertyType.BOOLEAN) {
                if (!StringUtils.equalsIgnoreCase(value, "true") && !StringUtils.equalsIgnoreCase(value, "false")) {
                    return Result.newError("notBoolean");
                }
            } else if (type == PropertyType.INTEGER) {
                if (!NumberUtils.isDigits(value)) {
                    return Result.newError("notInteger");
                }
            } else if (type == PropertyType.FLOAT) {
                try {
                    Double.parseDouble(value);
                } catch (NumberFormatException e) {
                    return Result.newError("notFloat");
                }
            } else if (type == PropertyType.SINGLE_SELECT_LIST) {
                if (!ArrayUtils.contains(options, value)) {
                    return Result.newError("notInOptions");
                }
            }
        }
        return Result.SUCCESS;
    }

    public String getKey() {
        return key;
    }

    public String getDefaultValue() {
        return defaultValue;
    }

    public String getName() {
        return name;
    }

    public PropertyType getType() {
        return type;
    }

    public String[] getOptions() {
        return options.clone();
    }

    public String getDescription() {
        return description;
    }

    public String getCategory() {
        return category;
    }

    public boolean isOnProject() {
        return onProject;
    }

    public boolean isOnModule() {
        return onModule;
    }

    public boolean isGlobal() {
        return isGlobal;
    }

    /**
     * @since 3.3
     */
    public boolean isMultiValues() {
        return multiValues;
    }

    /**
     * @since 3.3
     */
    public String getPropertySetKey() {
        return propertySetKey;
    }

    /**
     * @since 3.3
     */
    public List<PropertyFieldDefinition> getFields() {
        return fields;
    }

    /**
     * @since 3.4
     */
    public String getDeprecatedKey() {
        return deprecatedKey;
    }
}