org.carrot2.util.attribute.AttributeInfo.java Source code

Introduction

Here is the source code for org.carrot2.util.attribute.AttributeInfo.java

Source

/*
 * Carrot2 project.
 *
 * Copyright (C) 2002-2010, Dawid Weiss, Stanisaw Osiski.
 * All rights reserved.
 *
 * Refer to the full license file "carrot2.LICENSE"
 * in the root folder of the repository checkout or at:
 * http://www.carrot2.org/carrot2.LICENSE
 */

package org.carrot2.util.attribute;

import org.apache.commons.lang.ObjectUtils;
import org.apache.commons.lang.StringUtils;

/**
 * Description of an {@link Attribute} of a {@link Bindable} type, including
 * javadoc documentation and compile-time extracted tags.
 */
public final class AttributeInfo {
    /**
     * Attribute key.
     */
    public final String key;

    /**
     * Name of the declaring field.
     */
    public final String fieldName;

    /**
     * Name of the declaring class.
     */
    public final String className;

    /**
     * Complete JavaDoc.
     */
    public final String javaDoc;

    /**
     * Attribute label.
     */
    public final String label;

    /**
     * Attribute title.
     */
    public final String title;

    /**
     * Attribute description (javadoc excerpt).
     */
    public final String description;

    /**
     * Attribute group in the user interface.
     */
    public final String group;

    /**
     * Attribute level in the user interface.
     */
    public final AttributeLevel level;

    /*
     * 
     */
    public AttributeInfo(String key, String className, String fieldName, String javaDoc, String label, String title,
            String description, String group, AttributeLevel level, AttributeInfo inheritFrom) {
        this.fieldName = fieldName;
        this.className = className;

        this.key = key;
        if (inheritFrom == null) {
            this.javaDoc = javaDoc;
            this.label = label;
            this.title = title;
            this.description = description;

            this.group = group;
            this.level = level;
        } else {
            this.javaDoc = StringUtils.defaultString(javaDoc, inheritFrom.javaDoc);
            this.label = StringUtils.defaultString(label, inheritFrom.label);
            this.title = StringUtils.defaultString(title, inheritFrom.title);
            this.description = StringUtils.defaultString(description, inheritFrom.description);

            this.group = StringUtils.defaultString(group, inheritFrom.group);
            this.level = (AttributeLevel) ObjectUtils.defaultIfNull(level, inheritFrom.level);
        }
    }
}